Skip to content

Commit 8a054f0

Browse files
authored
Add FM and LDA to the documentation. (#66)
1 parent b45d79c commit 8a054f0

File tree

5 files changed

+52
-5
lines changed

5 files changed

+52
-5
lines changed

README.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ You can install from source by cloning this repository and issuing a pip install
3939

4040
git clone https://github.com/aws/sagemaker-python-sdk.git
4141
python setup.py sdist
42-
pip install dist/sagemaker-1.0.0.tar.gz
42+
pip install dist/sagemaker-1.0.3.tar.gz
4343

4444
Supported Python versions
4545
~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -1447,11 +1447,11 @@ Amazon SageMaker provides several built-in machine learning algorithms that you
14471447
14481448
The full list of algorithms is available on the AWS website: https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html
14491449
1450-
SageMaker Python SDK includes Estimator wrappers for the AWS K-means, Principal Components Analysis, and Linear Learner algorithms.
1450+
SageMaker Python SDK includes Estimator wrappers for the AWS K-means, Principal Components Analysis, Linear Learner, Factorization Machines and LDA algorithms.
14511451
14521452
Definition and usage
14531453
~~~~~~~~~~~~~~~~~~~~
1454-
Estimators that wrap Amazon's built-in algorithms define algorithm's hyperparameters with defaults. When a default is not possible you need to provide the value during construction:
1454+
Estimators that wrap Amazon's built-in algorithms define algorithm's hyperparameters with defaults. When a default is not possible you need to provide the value during construction, e.g.:
14551455
14561456
- ``KMeans`` Estimator requires parameter ``k`` to define number of clusters
14571457
- ``PCA`` Estimator requires parameter ``num_components`` to define number of principal components

doc/conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ def __getattr__(cls, name):
1818
'tensorflow.python.framework', 'tensorflow_serving', 'tensorflow_serving.apis']
1919
sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
2020

21-
version = '1.0'
21+
version = '1.0.3'
2222
project = u'sagemaker'
2323

2424
# Add any Sphinx extension module names here, as strings. They can be extensions

doc/factorization_machines.rst

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
FactorizationMachines
2+
-------------------------
3+
4+
The Amazon SageMaker Factorization Machines algorithm.
5+
6+
.. autoclass:: sagemaker.FactorizationMachines
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:
10+
:inherited-members:
11+
:exclude-members: image, num_factors, predictor_type, epochs, clip_gradient, mini_batch_size, feature_dim, eps, rescale_grad, bias_lr, linear_lr, factors_lr, bias_wd, linear_wd, factors_wd, bias_init_method, bias_init_scale, bias_init_sigma, bias_init_value, linear_init_method, linear_init_scale, linear_init_sigma, linear_init_value, factors_init_method, factors_init_scale, factors_init_sigma, factors_init_value
12+
13+
14+
.. autoclass:: sagemaker.FactorizationMachinesModel
15+
:members:
16+
:undoc-members:
17+
:show-inheritance:
18+
19+
.. autoclass:: sagemaker.FactorizationMachinesPredictor
20+
:members:
21+
:undoc-members:
22+
:show-inheritance:

doc/index.rst

+4-1
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,14 @@ A managed environment for TensorFlow training and hosting on Amazon SageMaker
3838

3939
SageMaker First-Party Algorithms
4040
--------------------------------
41-
Amazon provides implementations of some common machine learning algortithms optimized for GPU archicture and massive datasets.
41+
Amazon provides implementations of some common machine learning algortithms optimized for GPU architecture and massive datasets.
4242

4343
.. toctree::
4444
:maxdepth: 2
4545

4646
kmeans
4747
pca
4848
linear_learner
49+
sagemaker.amazon.amazon_estimator
50+
factorization_machines
51+
lda

doc/lda.rst

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
LDA
2+
--------------------
3+
4+
The Amazon SageMaker LDA algorithm.
5+
6+
.. autoclass:: sagemaker.LDA
7+
:members:
8+
:undoc-members:
9+
:show-inheritance:
10+
:inherited-members:
11+
:exclude-members: image, num_topics, alpha0, max_restarts, max_iterations, mini_batch_size, feature_dim, tol
12+
13+
14+
.. autoclass:: sagemaker.LDAModel
15+
:members:
16+
:undoc-members:
17+
:show-inheritance:
18+
19+
.. autoclass:: sagemaker.LDAPredictor
20+
:members:
21+
:undoc-members:
22+
:show-inheritance:

0 commit comments

Comments
 (0)