-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Chronos: how to guide page cleaning (#5657)
* update * add nblink * windows guide fix * add some updated * update chronos * add update image * add new image * add updates * add update * add new image * fix typo * fix notebook location * add new index * update * fix some doc * update tree * fix typo
- Loading branch information
1 parent
c73fc9f
commit 6b337b9
Showing
19 changed files
with
163 additions
and
1,361 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
71 changes: 71 additions & 0 deletions
71
docs/readthedocs/source/doc/Chronos/Howto/docker_guide_single_node.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
# Use Chronos in Container (docker) | ||
This dockerfile helps user to build a docker image where Chronos-nightly build version is deployed. | ||
|
||
## Build an image | ||
First clone the repo `BigDL` to the local. | ||
```bash | ||
git clone https://github.com/intel-analytics/BigDL.git | ||
``` | ||
Then `cd` to the root directory of `BigDL`, and copy the Dockerfile to it. | ||
```bash | ||
cd BigDL | ||
cp docker/chronos-nightly/Dockerfile ./Dockerfile | ||
``` | ||
Then build your docker image with Dockerfile: | ||
```bash | ||
sudo docker build -t chronos-nightly:b1 . # You may choose any NAME:TAG you want. | ||
``` | ||
(Optional) Or build with a proxy: | ||
```bash | ||
# typically, you need a proxy for building since there will be some downloading. | ||
sudo docker build \ | ||
--build-arg http_proxy=http://<your_proxy_ip>:<your_proxy_port> \ #optional | ||
--build-arg https_proxy=http://<your_proxy_ip>:<your_proxy_port> \ #optional | ||
-t chronos-nightly:b1 . # You may choose any NAME:TAG you want. | ||
``` | ||
According to your network status, this building will cost **15-30 mins**. | ||
|
||
**Tips:** When errors happen like `E: Package 'apt-utils' has no installation candidate`, it's usually related to the bad network status. Please build with a proxy. | ||
|
||
## Run the image | ||
```bash | ||
sudo docker run -it --rm --net=host chronos-nightly:b1 bash | ||
``` | ||
|
||
## Use Chronos | ||
A conda environment is created for you automatically. `bigdl-chronos` and all of its depenencies are installed inside this environment. | ||
```bash | ||
(chronos) root@cpx-3:/opt/work# | ||
``` | ||
|
||
## Run unitest examples on Jupyter Notebook for a quick use | ||
You can run these on Jupyter Notebook on single node server if you pursue a quick use on Chronos. | ||
```bash | ||
(chronos) root@cpx-3:/opt/work# cd /opt/work/colab-notebook #Unitest examples are here. | ||
``` | ||
```bash | ||
(chronos) root@cpx-3:/opt/work# jupyter notebook --notebook-dir=./ --ip=* --allow-root #Start the Jupyter Notebook services. | ||
``` | ||
After the Jupyter Notebook service is successfully started, you can connect to the Jupyter Notebook service from a browser. | ||
1. Get the IP address of the container | ||
2. Launch a browser, and connect to the Jupyter Notebook service with the URL: | ||
</br>`https://container-ip-address:port-number/?token=your-token` | ||
</br>As a result, you will see the Jupyter Notebook opened. | ||
3. Open one of these `.ipynb` files, run through the example and learn how to use Chronos to predict time series. | ||
|
||
## Shut down docker container | ||
You should shut down the BigDL Docker container after using it. | ||
1. First, use `ctrl+p+q` to quit the container when you are still in it. | ||
2. Then, you can list all the active Docker containers by command line: | ||
```bash | ||
sudo docker ps | ||
``` | ||
You will see your docker containers: | ||
```bash | ||
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES | ||
40de2cdad025 chronos-nightly:b1 "/opt/work/" 3 hours ago Up 3 hours upbeat_al | ||
``` | ||
3. Shut down the corresponding docker container by its ID: | ||
```bash | ||
sudo docker rm -f 40de2cdad025 | ||
``` |
206 changes: 0 additions & 206 deletions
206
docs/readthedocs/source/doc/Chronos/Howto/how-to-create-forecaster.ipynb
This file was deleted.
Oops, something went wrong.
3 changes: 3 additions & 0 deletions
3
docs/readthedocs/source/doc/Chronos/Howto/how_to_create_forecaster.nblink
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
{ | ||
"path": "../../../../../../python/chronos/colab-notebook/howto/how-to-create-forecaster.ipynb" | ||
} |
Oops, something went wrong.