Skip to content

Commit 6e5d247

Browse files
ragdhallRaghav Dhall
andauthored
documentation: update first-party algorithms and structural updates (#3300)
* documentation: update first-party algorithms and structural updates * documentation: minor style changes to pass codebuild * documentation: more minor edits Co-authored-by: Raghav Dhall <[email protected]>
1 parent cd4b273 commit 6e5d247

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+553
-14
lines changed

doc/algorithms/index.rst

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,15 @@
11
######################
2-
First-Party Algorithms
2+
Built-in Algorithms
33
######################
44

55
Amazon SageMaker provides implementations of some common machine learning algorithms optimized for GPU architecture and massive datasets.
66

77
.. toctree::
88
:maxdepth: 2
99

10-
sagemaker.amazon.amazon_estimator
11-
factorization_machines
12-
ipinsights
13-
kmeans
14-
knn
15-
lda
16-
linear_learner
17-
ntm
18-
object2vec
19-
pca
20-
randomcutforest
10+
tabular/index
11+
text/index
12+
time_series/index
13+
unsupervised/index
14+
vision/index
15+
other/index

doc/algorithms/other/index.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
######################
2+
Other
3+
######################
4+
5+
:ref:`All Pre-trained Models <all-pretrained-models>`
6+
7+
.. toctree::
8+
:maxdepth: 2
9+
10+
sagemaker.amazon.amazon_estimator
File renamed without changes.

doc/algorithms/tabular/autogluon.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
############
2+
AutoGluon
3+
############
4+
5+
`AutoGluon-Tabular <https://auto.gluon.ai/stable/index.html>`__ is a popular open-source AutoML framework that trains highly accurate machine learning models on an unprocessed tabular dataset.
6+
Unlike existing AutoML frameworks that primarily focus on model and hyperparameter selection, AutoGluon-Tabular succeeds by ensembling multiple models and stacking them in multiple layers.
7+
8+
9+
The following table outlines a variety of sample notebooks that address different use cases of Amazon SageMaker AutoGluon-Tabular algorithm.
10+
11+
.. list-table::
12+
:widths: 25 25
13+
:header-rows: 1
14+
15+
* - Notebook Title
16+
- Description
17+
* - `Tabular classification with Amazon SageMaker AutoGluon-Tabular algorithm <https://github.com/aws/amazon-sagemaker-examples/blob/main/introduction_to_amazon_algorithms/autogluon_tabular/Amazon_Tabular_Classification_AutoGluon.ipynb>`__
18+
- This notebook demonstrates the use of the Amazon SageMaker AutoGluon-Tabular algorithm to train and host a tabular classification model.
19+
* - `Tabular regression with Amazon SageMaker AutoGluon-Tabular algorithm <https://github.com/aws/amazon-sagemaker-examples/blob/main/introduction_to_amazon_algorithms/autogluon_tabular/Amazon_Tabular_Regression_AutoGluon.ipynb>`__
20+
- This notebook demonstrates the use of the Amazon SageMaker AutoGluon-Tabular algorithm to train and host a tabular regression model.
21+
22+
23+
For instructions on how to create and access Jupyter notebook instances that you can use to run the example in SageMaker, see
24+
`Use Amazon SageMaker Notebook Instances <https://docs.aws.amazon.com/sagemaker/latest/dg/nbi.html>`__. After you have created a notebook
25+
instance and opened it, choose the SageMaker Examples tab to see a list of all of the SageMaker samples. To open a notebook, choose its
26+
Use tab and choose Create copy.
27+
28+
For detailed documentation, please refer to the `Sagemaker AutoGluon-Tabular Algorithm <https://docs.aws.amazon.com/sagemaker/latest/dg/autogluon-tabular.html>`__.

doc/algorithms/tabular/catboost.rst

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
############
2+
CatBoost
3+
############
4+
5+
6+
`CatBoost <https://catboost.ai/>`__ is a popular and high-performance open-source implementation of the Gradient Boosting Decision Tree (GBDT)
7+
algorithm. GBDT is a supervised learning algorithm that attempts to accurately predict a target variable by combining an ensemble of
8+
estimates from a set of simpler and weaker models.
9+
10+
CatBoost introduces two critical algorithmic advances to GBDT:
11+
12+
* The implementation of ordered boosting, a permutation-driven alternative to the classic algorithm
13+
14+
* An innovative algorithm for processing categorical features
15+
16+
Both techniques were created to fight a prediction shift caused by a special kind of target leakage present in all currently existing
17+
implementations of gradient boosting algorithms.
18+
19+
The following table outlines a variety of sample notebooks that address different use cases of Amazon SageMaker CatBoost algorithm.
20+
21+
.. list-table::
22+
:widths: 25 25
23+
:header-rows: 1
24+
25+
* - Notebook Title
26+
- Description
27+
* - `Tabular classification with Amazon SageMaker LightGBM and CatBoost algorithm <https://github.com/aws/amazon-sagemaker-examples/blob/main/introduction_to_amazon_algorithms/lightgbm_catboost_tabular/Amazon_Tabular_Classification_LightGBM_CatBoost.ipynb>`__
28+
- This notebook demonstrates the use of the Amazon SageMaker CatBoost algorithm to train and host a tabular classification model.
29+
* - `Tabular regression with Amazon SageMaker LightGBM and CatBoost algorithm <https://github.com/aws/amazon-sagemaker-examples/blob/main/introduction_to_amazon_algorithms/lightgbm_catboost_tabular/Amazon_Tabular_Regression_LightGBM_CatBoost.ipynb>`__
30+
- This notebook demonstrates the use of the Amazon SageMaker CatBoost algorithm to train and host a tabular regression model.
31+
32+
For instructions on how to create and access Jupyter notebook instances that you can use to run the example in SageMaker, see
33+
`Use Amazon SageMaker Notebook Instances <https://docs.aws.amazon.com/sagemaker/latest/dg/nbi.html>`__. After you have created a notebook
34+
instance and opened it, choose the SageMaker Examples tab to see a list of all of the SageMaker samples. To open a notebook, choose its
35+
Use tab and choose Create copy.
36+
37+
For detailed documentation, please refer to the `Sagemaker CatBoost Algorithm <https://docs.aws.amazon.com/sagemaker/latest/dg/catboost.html>`__.

doc/algorithms/factorization_machines.rst renamed to doc/algorithms/tabular/factorization_machines.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
FactorizationMachines
1+
Factorization Machines
22
-------------------------
33

44
The Amazon SageMaker Factorization Machines algorithm.

doc/algorithms/tabular/index.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
######################
2+
Tabular
3+
######################
4+
5+
Amazon SageMaker provides built-in algorithms that are tailored to the analysis of tabular data. The built-in SageMaker algorithms for tabular data can be used for either classification or regression problems.
6+
7+
.. toctree::
8+
:maxdepth: 2
9+
10+
autogluon
11+
catboost
12+
factorization_machines
13+
knn
14+
lightgbm
15+
linear_learner
16+
tabtransformer
17+
xgboost
18+
object2vec
File renamed without changes.

doc/algorithms/tabular/lightgbm.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
############
2+
LightGBM
3+
############
4+
5+
`LightGBM <https://lightgbm.readthedocs.io/en/latest/>`__ is a popular and efficient open-source implementation of the Gradient Boosting
6+
Decision Tree (GBDT) algorithm. GBDT is a supervised learning algorithm that attempts to accurately predict a target variable by
7+
combining an ensemble of estimates from a set of simpler and weaker models. LightGBM uses additional techniques to significantly improve
8+
the efficiency and scalability of conventional GBDT.
9+
10+
The following table outlines a variety of sample notebooks that address different use cases of Amazon SageMaker LightGBM algorithm.
11+
12+
.. list-table::
13+
:widths: 25 25
14+
:header-rows: 1
15+
16+
* - Notebook Title
17+
- Description
18+
* - `Tabular classification with Amazon SageMaker LightGBM and CatBoost algorithm <https://github.com/aws/amazon-sagemaker-examples/blob/main/introduction_to_amazon_algorithms/lightgbm_catboost_tabular/Amazon_Tabular_Classification_LightGBM_CatBoost.ipynb>`__
19+
- This notebook demonstrates the use of the Amazon SageMaker LightGBM algorithm to train and host a tabular classification model.
20+
* - `Tabular regression with Amazon SageMaker LightGBM and CatBoost algorithm <https://github.com/aws/amazon-sagemaker-examples/blob/main/introduction_to_amazon_algorithms/lightgbm_catboost_tabular/Amazon_Tabular_Regression_LightGBM_CatBoost.ipynb>`__
21+
- This notebook demonstrates the use of the Amazon SageMaker LightGBM algorithm to train and host a tabular regression model.
22+
23+
For instructions on how to create and access Jupyter notebook instances that you can use to run the example in SageMaker, see
24+
`Use Amazon SageMaker Notebook Instances <https://docs.aws.amazon.com/sagemaker/latest/dg/nbi.html>`__. After you have created a notebook
25+
instance and opened it, choose the SageMaker Examples tab to see a list of all of the SageMaker samples. To open a notebook, choose its
26+
Use tab and choose Create copy.
27+
28+
For detailed documentation, please refer to the `Sagemaker LightGBM Algorithm <https://docs.aws.amazon.com/sagemaker/latest/dg/lightgbm.html>`__.
File renamed without changes.

0 commit comments

Comments
 (0)