Chronos: user guide revision/update #3220
Merged
Conversation
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
Closed
jason-dai
reviewed
Oct 24, 2021
| @@ -13,42 +13,96 @@ You can use _Chronos_ to do: | |||
| --- | |||
| ### **2 Install** | |||
|
|
|||
| Install analytics-zoo with target `[automl]` to install the additional dependencies for _Chronos_. | |||
| Install `bigdl-chronos` and with target `[all]` to install the additional dependencies for _Chronos_. | |||
There was a problem hiding this comment.
- Users should use
pip install bigdl-chronosin the most case (i.e., that's the default use case), and that's what you should show in the user guide - After that, you may describe what other options are available
jason-dai
reviewed
Oct 24, 2021
| ``` | ||
| --- | ||
| ### **3 Initialization** | ||
| ### **3 Run** | ||
|
|
There was a problem hiding this comment.
Run means how to run chronos programs; see https://bigdl.readthedocs.io/en/latest/doc/UserGuide/python.html#run and https://bigdl-project.github.io/master/#PythonUserGuide/run-from-pip/
jason-dai
reviewed
Oct 24, 2021
|
|
||
| _Chronos_ uses [Orca](../../Orca/Overview/orca.md) to enable distributed training and AutoML capabilities. Init orca as below when you want to: | ||
| _Chronos_ uses [Orca](../../Orca/Overview/orca.md) to enable distributed training and AutoML capabilities. Initial orca as below when you want to: |
There was a problem hiding this comment.
These probably should go to Get started
jason-dai
reviewed
Oct 24, 2021
| --- | ||
| <span id="TSDataset"></span> | ||
| ### **4 Data Processing and Feature Engineering** | ||
| ### **5 Data Processing and Feature Engineering** |
There was a problem hiding this comment.
Maybe it's better to move below sections to individual pages (and also add AutoML descriptions)?
TheaperDeng
force-pushed
the
chronos-ug-revise-to-bigdl
branch
from
fe5f1b6 to
4e928a9
Compare
jason-dai
reviewed
Oct 25, 2021
| [`TSDataset`](../../PythonAPI/Chronos/tsdataset.html) is designed for general time series processing while providing many specific operations for the convenience of different tasks(e.g. forecasting, anomaly detection). | ||
| ### **3 Run** | ||
| Various python programming environments are supported to run a _Chronos_ application. | ||
| #### **3.1 Interactive Shell** |
There was a problem hiding this comment.
maybe this is not needed?
jason-dai
reviewed
Oct 25, 2021
|
|
||
| [`TSDataset`](../../PythonAPI/Chronos/tsdataset.html) is designed for general time series processing while providing many specific operations for the convenience of different tasks(e.g. forecasting, anomaly detection). | ||
|
|
||
| ## **1 Basic concepts** |
There was a problem hiding this comment.
## **1. Basic concepts**
jason-dai
reviewed
Oct 25, 2021
|
|
||
| All the preprocessing operations will be done on each independent time series(i.e on both feature dimension and id dimension), while feature scaling will be only carried out on the feature dimension. | ||
|
|
||
| ## **2 Create a TSDataset** |
There was a problem hiding this comment.
## **2. Create a TSDataset**
jason-dai
reviewed
Oct 25, 2021
| @@ -13,517 +13,123 @@ You can use _Chronos_ to do: | |||
| --- | |||
| ### **2 Install** | |||
jason-dai
reviewed
Oct 25, 2021
| ``` | ||
|
|
||
| #### **5.3 Use Standalone Forecaster Pipeline** | ||
| ### **4 Get Started** |
jason-dai
reviewed
Oct 25, 2021
|  | ||
|
|
||
| After training, start the tensorboard server through | ||
| This example run a forecasting task with automl optimization with `AutoTSEstimator` on New York City Taxi Dataset. To run this example, install the following: `pip install --pre --upgrade bigdl-chronos[all]`. |
There was a problem hiding this comment.
####4.2 AutoTS Example####
jason-dai
reviewed
Oct 25, 2021
| ``` | ||
|
|
||
| ### **9 Examples and Demos** | ||
| ### **5 Examples and Demos** |
There was a problem hiding this comment.
Add a Details section before this, with links to data_processing_feature_engineering, forecasting, simulation, etc.
dding3
pushed a commit
to dding3/BigDL
that referenced
this pull request
Nov 17, 2021
* orca pytorch add predict * meet comments * meet comments
dding3
pushed a commit
to dding3/BigDL
that referenced
this pull request
Nov 17, 2021
* add new content to ug of chronos * add link revise * fix broken links * add changes according to comments * add updates * fix typos * change typos
dding3
pushed a commit
to dding3/BigDL
that referenced
this pull request
Nov 17, 2021
* orca pytorch add predict * meet comments * meet comments
dding3
pushed a commit
to dding3/BigDL
that referenced
this pull request
Nov 17, 2021
* orca pytorch add predict * meet comments * meet comments
liu-shaojun
pushed a commit
that referenced
this pull request
Mar 25, 2024
* add new content to ug of chronos * add link revise * fix broken links * add changes according to comments * add updates * fix typos * change typos
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
related to #3198
preview: https://bigdl-junweid.readthedocs.io/en/latest/doc/Chronos/Overview/chronos.html#