Skip to content

Commit b17db8f

Browse files
committed
reformat operators docs
1 parent 6df592a commit b17db8f

File tree

8 files changed

+16
-17
lines changed

8 files changed

+16
-17
lines changed

docs/source/user_guide/operators/anomaly_detection_operator/advanced_use_cases.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,14 @@
22
Advanced Use Cases
33
==================
44

5-
**Documentation: Anomaly Detection Science and Model Parameterization**
6-
75
The Science of Anomaly Detection
86
--------------------------------
97

108
Anomaly Detection comes in many forms. We will go through some of these and give guidance as to whether this Operator is going to be helpful for each use case.
119

1210
* Constructive v Destructive v Pre-Processing: This Operator focuses on the Constructive and Pre-Processing use cases. Destructive can work, but more specific parameters may be required.
1311
* Supervised v Semi-Supervised v Unsupervised: All 3 of these approaches are supported by AutoMLX. AutoTS supports only Unsupervised at this time.
14-
* Time Series. This Operator is focused on just time-series data.
12+
* Time Series. This Operator requires time-series data.
1513

1614

1715
Data Parameterization
@@ -55,6 +53,9 @@ Data Parameterization
5553
target_column: y
5654
5755
56+
Model Parameterization
57+
----------------------
58+
5859
**Specify Model Type**
5960

6061
Sometimes users will know which models they want to use. When users know this in advance, they can specify using the ``model_kwargs`` dictionary. In the following example, we will instruct the model to *only* use the ``IsolationForestOD`` model.

docs/source/user_guide/operators/anomaly_detection_operator/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
==========================
2-
Anomaly Detection Operator
3-
==========================
1+
=================
2+
Anomaly Detection
3+
=================
44

55
The Anomaly Detection Operator is a low code tool for integrating Anomaly Detection into any enterprise applicaiton. Specifically, it leverages timeseries constructive anomaly detection in order to flag anomolous moments in your data, by time and by ID.
66

docs/source/user_guide/operators/anomaly_detection_operator/productionize.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,8 @@ The report.html file is designed differently for each model type. Generally, it
7272
The metrics file includes relevant metrics calculated on the training set.
7373

7474

75-
========
7675
Examples
77-
========
76+
--------
7877

7978
**Simple Example**
8079

docs/source/user_guide/operators/forecasting_operator/advanced_use_cases.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
Advanced Use Cases
33
==================
44

5-
65
The Science of Forecasting
76
--------------------------
87

docs/source/user_guide/operators/forecasting_operator/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
====================
2-
Forecasting Operator
3-
====================
1+
===========
2+
Forecasting
3+
===========
44

55
The Forecasting Operator leverages historical time series data to generate accurate forecasts for future trends. This operator aims to simplify and expedite the data science process by automating the selection of appropriate models and hyperparameters, as well as identifying relevant features for a given prediction task.
66

docs/source/user_guide/operators/forecasting_operator/productionize.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ While local explanations offer granular insights, they may not provide a compreh
110110

111111

112112
Examples
113-
========
113+
--------
114114

115115
**Simple Example**
116116

docs/source/user_guide/operators/pii_operator/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
============
2-
PII Operator
3-
============
1+
===
2+
PII
3+
===
44

55
The PII operator aims to detect and redact Personally Identifiable Information(PII) in datasets by combining pattern match and machine learning solution.
66

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ forecast = [
179179
"oracledb",
180180
]
181181
anomaly = [
182-
"tods @ git+https://github.com/datamllab/tods.git",
182+
"oracle_ads[opctl]",
183183
"autots",
184184
"oracle-automlx[anomaly]==23.2.3",
185185
"oracledb",

0 commit comments

Comments
 (0)