Skip to content

Commit 11cdab5

Browse files
aaronmarkhamaaronmarkham
authored
Website (#1631) (#1742)
* initial site * set nbsphinx to never execute * site with all notebooks * remove broken notebooks * index pages for subfolders * update toc * update autopilot, add marketplace and debugger and ground truth * add experiments * add debugger examples * add rl examples * add training content * port over more algo examples; fix gt menu * add inference, distributed content; landing image and overview * fix menu; reduce getting started * resolve errors; add more notebooks * add analytics * fix errors * fix errors
1 parent 704e3dc commit 11cdab5

File tree

43 files changed

+1917
-3
lines changed

Some content is hidden

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

43 files changed

+1917
-3
lines changed

Diff for: ‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@
33
**/__pycache__
44
**/.aws-sam
55
.DS_Store
6+
**/_build

Diff for: ‎.readthedocs.yml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# ReadTheDocs environment customization to allow us to use conda to install
2+
# libraries which have C dependencies for the doc build. See:
3+
# https://docs.readthedocs.io/en/latest/config-file/v2.html
4+
5+
version: 2
6+
7+
conda:
8+
environment: environment.yml
9+
10+
python:
11+
version: 3.6
12+
13+
sphinx:
14+
configuration: conf.py
15+
fail_on_warning: false

Diff for: ‎Makefile

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = .
9+
BUILDDIR = _build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

Diff for: ‎_static/js/analytics.js

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
console.log("Starting analytics...");
2+
var s_code=s.t();if(s_code)document.write(s_code)

Diff for: ‎_static/product-icon_Amazon_SageMaker_lockup_centered_squid_ink.png

4.99 KB
Loading

Diff for: ‎_static/sagemaker_gears.jpg

26.3 KB
Loading

Diff for: ‎autopilot/index.rst

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
Get started with Autopilot
2+
==========================
3+
4+
.. image:: https://readthedocs.org/projects/sagemaker-examples-test-website/badge/?version=latest
5+
6+
.. toctree::
7+
:maxdepth: 0
8+
9+
sagemaker_autopilot_direct_marketing
10+
11+
12+
Feature selection
13+
==========================
14+
15+
.. toctree::
16+
:maxdepth: 0
17+
18+
custom-feature-selection/Feature_selection_autopilot
19+
20+
21+
Model explainability
22+
==========================
23+
24+
.. toctree::
25+
:maxdepth: 0
26+
27+
model-explainability/explaining_customer_churn_model

Diff for: ‎autopilot/sagemaker_autopilot_direct_marketing.ipynb

-3
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,6 @@
55
"metadata": {},
66
"source": [
77
"# Direct Marketing with Amazon SageMaker Autopilot\n",
8-
"---\n",
9-
"\n",
10-
"---\n",
118
"\n",
129
"Kernel `Python 3 (Data Science)` works well with this notebook."
1310
]

Diff for: ‎aws_marketplace/index.rst

+105
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
################
2+
AWS Marketplace
3+
################
4+
5+
Publish algorithm on the AWS Marketplace
6+
===========================================
7+
8+
Create your algorithm and model package
9+
----------------------------------------
10+
11+
.. toctree::
12+
:maxdepth: 0
13+
14+
creating_marketplace_products/Bring_Your_Own-Creating_Algorithm_and_Model_Package
15+
16+
17+
Curate your sample notebook
18+
---------------------------
19+
20+
..
21+
#these need to be rst files
22+
:doc:`Curating a good algorithm listing <curating_aws_marketplace_listing_and_sample_notebook/Algorithm/curating_good_algorithm_listing>`
23+
:doc:`Curating a good model package listing <curating_aws_marketplace_listing_and_sample_notebook/ModelPackage/curating_good_model_package_listing>`
24+
25+
26+
Templates
27+
---------
28+
29+
.. toctree::
30+
:maxdepth: 0
31+
32+
curating_aws_marketplace_listing_and_sample_notebook/Algorithm/Sample_Notebook_Template/title_of_your_product-Algorithm
33+
curating_aws_marketplace_listing_and_sample_notebook/ModelPackage/Sample_Notebook_Template/title_of_your_product-Model
34+
35+
36+
Use AWS Marketplace algorithms
37+
==============================
38+
39+
.. toctree::
40+
:maxdepth: 0
41+
42+
using_algorithms/amazon_demo_product/Using_Algorithm_Arn_From_AWS_Marketplace
43+
44+
45+
Autogluon
46+
---------
47+
48+
.. toctree::
49+
:maxdepth: 0
50+
51+
using_algorithms/autogluon/autogluon_tabular_marketplace
52+
53+
54+
AutoML
55+
------
56+
57+
.. toctree::
58+
:maxdepth: 0
59+
60+
using_algorithms/automl/AutoML_-_Train_multiple_models_in_parallel
61+
62+
63+
Use AWS Marketplace model packages
64+
==================================
65+
66+
.. toctree::
67+
:maxdepth: 0
68+
69+
using_model_packages/amazon_demo_product/Using_ModelPackage_Arn_From_AWS_Marketplace
70+
71+
72+
Auto insurance
73+
--------------
74+
75+
.. toctree::
76+
:maxdepth: 0
77+
78+
using_model_packages/auto_insurance/automating_auto_insurance_claim_processing
79+
80+
81+
Financial transaction processing
82+
--------------------------------
83+
84+
.. toctree::
85+
:maxdepth: 0
86+
87+
using_model_packages/financial_transaction_processing/Extracting_insights_from_your_credit_card_statement
88+
89+
90+
Improving industrial workplace safety
91+
-------------------------------------
92+
93+
.. toctree::
94+
:maxdepth: 0
95+
96+
using_model_packages/improving_industrial_workplace_safety/improving_industrial_workplace_safety
97+
98+
99+
Generic sample notebook
100+
-----------------------
101+
102+
.. toctree::
103+
:maxdepth: 0
104+
105+
using_model_packages/generic_sample_notebook/A_generic_sample_notebook_to_perform_inference_on_ML_model_packages_from_AWS_Marketplace

Diff for: ‎aws_sagemaker_studio/index.rst

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
Get started with Studio
2+
=======================
3+
4+
.. toctree::
5+
:maxdepth: 1
6+
7+
sagemaker_algorithms/linear_learner_mnist/linear_learner_mnist
8+
9+
10+
11+
Framework examples
12+
=======================
13+
14+
.. toctree::
15+
:maxdepth: 1
16+
17+
frameworks/keras_pipe_mode_horovod/keras_pipe_mode_horovod_cifar10
18+
frameworks/mxnet_gluon_sentiment/mxnet_sentiment_analysis_with_gluon
19+
frameworks/mxnet_mnist/mxnet_mnist_with_batch_transform
20+
frameworks/mxnet_onnx_ei/mxnet_onnx_ei
21+
frameworks/pytorch_cnn_cifar10/pytorch_cnn_cifar10
22+
23+
24+
Model compilation with Neo
25+
==========================
26+
27+
.. toctree::
28+
:maxdepth: 1
29+
30+
sagemaker_neo_compilation_jobs/deploy_tensorflow_model_on_Inf1_instance/tensorflow_distributed_mnist_neo_inf1_studio
31+
32+
33+
Bring your own container to Studio
34+
==================================
35+
36+
.. toctree::
37+
:maxdepth: 1
38+
39+
sagemaker_studio_image_build/xgboost_bring_your_own/Batch_Transform_BYO_XGB

Diff for: ‎code_snippets/index.rst

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
######################
2+
Code Snippets
3+
######################
4+
5+
.. toctree::
6+
:maxdepth: 1
7+
:glob:
8+
9+
*

Diff for: ‎conf.py

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Configuration file for the Sphinx documentation builder.
2+
#
3+
# This file only contains a selection of the most common options. For a full
4+
# list see the documentation:
5+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
6+
7+
# -- Path setup --------------------------------------------------------------
8+
9+
# If extensions (or modules to document with autodoc) are in another directory,
10+
# add these directories to sys.path here. If the directory is relative to the
11+
# documentation root, use os.path.abspath to make it absolute, like shown here.
12+
#
13+
# import os
14+
# import sys
15+
# sys.path.insert(0, os.path.abspath('.'))
16+
17+
18+
# -- Project information -----------------------------------------------------
19+
20+
project = 'Amazon SageMaker Examples'
21+
copyright = '2020, Aaron Markham'
22+
author = 'Aaron Markham'
23+
24+
# The full version, including alpha/beta/rc tags
25+
release = '1.0.0'
26+
27+
28+
# -- General configuration ---------------------------------------------------
29+
30+
# Add any Sphinx extension module names here, as strings. They can be
31+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
32+
# ones.
33+
extensions = [
34+
"nbsphinx",
35+
]
36+
37+
# extension nbsphinx config
38+
nbsphinx_execute = 'never'
39+
40+
41+
# Add any paths that contain templates here, relative to this directory.
42+
templates_path = ['_templates']
43+
44+
# List of patterns, relative to source directory, that match files and
45+
# directories to ignore when looking for source files.
46+
# This pattern also affects html_static_path and html_extra_path.
47+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
48+
49+
50+
# -- Options for HTML output -------------------------------------------------
51+
52+
# The theme to use for HTML and HTML Help pages. See the documentation for
53+
# a list of builtin themes.
54+
#
55+
html_theme = 'sphinx_rtd_theme'
56+
57+
# Add any paths that contain custom static files (such as style sheets) here,
58+
# relative to this directory. They are copied after the builtin static files,
59+
# so a file named "default.css" will overwrite the builtin "default.css".
60+
html_static_path = ['_static']
61+
62+
# For Adobe Analytics
63+
html_js_files = ["https://a0.awsstatic.com/s_code/js/1.0/awshome_s_code.js", "js/analytics.js"]

Diff for: ‎contrib/index.rst

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
Contributions
2+
=============
3+
4+
Contributions welcome!
5+
6+
Template
7+
--------
8+
The following notebook is a template that you can use to contribute a new notebook.
9+
10+
.. toctree::
11+
:maxdepth: 1
12+
13+
template
14+
15+
Upgrade
16+
-------
17+
18+
.. toctree::
19+
:maxdepth: 1
20+
21+
../sagemaker-python-sdk/upgrade_to_v2/upgrade_to_v2

Diff for: ‎template.ipynb renamed to ‎contrib/template.ipynb

File renamed without changes.

Diff for: ‎environment.yml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
dependencies:
2+
- pip:
3+
- nbsphinx==0.7.1
4+
- sagemaker==1.7.2

Diff for: ‎get_started/index.rst

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
Introduction to applying machine learning
2+
=========================================
3+
4+
.. toctree::
5+
:maxdepth: 1
6+
7+
../introduction_to_applying_machine_learning/video_game_sales/video-game-sales-xgboost
8+
../introduction_to_applying_machine_learning/breast_cancer_prediction/Breast Cancer Prediction
9+
../introduction_to_applying_machine_learning/xgboost_customer_churn/xgboost_customer_churn
10+
11+
12+
Training
13+
=================================
14+
15+
.. toctree::
16+
:maxdepth: 1
17+
18+
../introduction_to_amazon_algorithms/xgboost_mnist/xgboost_mnist
19+
../introduction_to_applying_machine_learning/ensemble_modeling/EnsembleLearnerCensusIncome
20+
21+
22+
Inference
23+
=========
24+
25+
.. toctree::
26+
:maxdepth: 1
27+
28+
../introduction_to_amazon_algorithms/blazingtext_hosting_pretrained_fasttext/blazingtext_hosting_pretrained_fasttext

0 commit comments

Comments
 (0)