Commit 1f6c645
documentation: PySDK V3 Documentation (#5472)
* feat: Add basic V3 documentation structure and configuration (#5445)
- Add ReadTheDocs configuration with sphinx-book-theme
- Create comprehensive overview, installation, and quickstart pages
- Set up documentation structure for all core capabilities
- Add custom CSS and Sphinx configuration
- Create symlinks to v3-examples and sagemaker-core directories
- Add docs/_build/ to .gitignore to exclude build artifacts
Co-authored-by: adishaa <adishaa@amazon.com>
* doc: Add content for V3 training, inference, model customization, ml_ops and sagemaker core (#5446)
* feat: Add basic V3 documentation structure and configuration
- Add ReadTheDocs configuration with sphinx-book-theme
- Create comprehensive overview, installation, and quickstart pages
- Set up documentation structure for all core capabilities
- Add custom CSS and Sphinx configuration
- Create symlinks to v3-examples and sagemaker-core directories
- Add docs/_build/ to .gitignore to exclude build artifacts
* feat: Add comprehensive training, inference, and model customization content
- Add detailed model customization with SFTTrainer, DPOTrainer, RLAIFTrainer, RLVRTrainer
- Include unified ModelTrainer interface for training workflows
- Add ModelBuilder for streamlined inference deployment
- Cover LoRA, full fine-tuning, and advanced ML techniques
- Include migration guides and production-ready examples
* feat: Add ML Ops and SageMaker Core documentation
- Add comprehensive MLOps pipeline orchestration and monitoring
- Include SageMaker Core low-level API documentation
- Cover advanced pipeline features and governance capabilities
---------
Co-authored-by: adishaa <adishaa@amazon.com>
* doc: Add comprehensive V3 documentation with enhanced UI (#5448)
- Add complete documentation structure for SageMaker Python SDK V3
- Implement eye-catching card-based UI for 'What's New' section
- Position model customization as flagship V3 feature with prominent highlighting
- Add comprehensive content for training, inference, ML ops, and core modules
- Include collapsed navigation with model customization emphasis
- Set up ReadTheDocs configuration and Sphinx documentation system
- Add installation guide, quickstart, and overview pages
- Link to staging repository examples and notebooks
Co-authored-by: adishaa <adishaa@amazon.com>
* doc: V3 documentation feedback component and API documentation (#5450)
* feat: Add comprehensive V3 documentation with enhanced UI
- Add complete documentation structure for SageMaker Python SDK V3
- Implement eye-catching card-based UI for 'What's New' section
- Position model customization as flagship V3 feature with prominent highlighting
- Add comprehensive content for training, inference, ML ops, and core modules
- Include collapsed navigation with model customization emphasis
- Set up ReadTheDocs configuration and Sphinx documentation system
- Add installation guide, quickstart, and overview pages
- Link to staging repository examples and notebooks
* feat: Add comprehensive feedback component with light theme
- Add thumbs up/down feedback buttons with SVG icons
- Show detailed feedback options when thumbs down is selected
- Include 5 checkbox options: hard to understand, code doesn't work, couldn't find, out of date, other
- Add textarea for additional feedback details
- Implement light theme styling with proper contrast
- Position component at bottom of each documentation page
- Include analytics tracking for feedback data
- Support multiple selection of feedback reasons
* Add API documentation using autodoc and autosummary
---------
Co-authored-by: adishaa <adishaa@amazon.com>
* doc: V3 documentation update (#5452)
* feat: Add comprehensive V3 documentation with enhanced UI
- Add complete documentation structure for SageMaker Python SDK V3
- Implement eye-catching card-based UI for 'What's New' section
- Position model customization as flagship V3 feature with prominent highlighting
- Add comprehensive content for training, inference, ML ops, and core modules
- Include collapsed navigation with model customization emphasis
- Set up ReadTheDocs configuration and Sphinx documentation system
- Add installation guide, quickstart, and overview pages
- Link to staging repository examples and notebooks
* feat: Add comprehensive feedback component with light theme
- Add thumbs up/down feedback buttons with SVG icons
- Show detailed feedback options when thumbs down is selected
- Include 5 checkbox options: hard to understand, code doesn't work, couldn't find, out of date, other
- Add textarea for additional feedback details
- Implement light theme styling with proper contrast
- Position component at bottom of each documentation page
- Include analytics tracking for feedback data
- Support multiple selection of feedback reasons
* Add API documentation using autodoc and autosummary
* doc: Documentation v3 improvements
* docs: Update requirements.txt for documentation build
* docs: Add sphinx-design to requirements.txt for ReadTheDocs build
---------
Co-authored-by: adishaa <adishaa@amazon.com>
* doc: Update Inference and Model Customization docs (#5454)
* feat: Add comprehensive V3 documentation with enhanced UI
- Add complete documentation structure for SageMaker Python SDK V3
- Implement eye-catching card-based UI for 'What's New' section
- Position model customization as flagship V3 feature with prominent highlighting
- Add comprehensive content for training, inference, ML ops, and core modules
- Include collapsed navigation with model customization emphasis
- Set up ReadTheDocs configuration and Sphinx documentation system
- Add installation guide, quickstart, and overview pages
- Link to staging repository examples and notebooks
* feat: Add comprehensive feedback component with light theme
- Add thumbs up/down feedback buttons with SVG icons
- Show detailed feedback options when thumbs down is selected
- Include 5 checkbox options: hard to understand, code doesn't work, couldn't find, out of date, other
- Add textarea for additional feedback details
- Implement light theme styling with proper contrast
- Position component at bottom of each documentation page
- Include analytics tracking for feedback data
- Support multiple selection of feedback reasons
* Add API documentation using autodoc and autosummary
* doc: Documentation v3 improvements
* docs: Update requirements.txt for documentation build
* docs: Add sphinx-design to requirements.txt for ReadTheDocs build
* docs: Remove unsupported LoRAConfig/TrainingConfig and update preference_dataset to training_dataset
* doc: Update inference docs
---------
Co-authored-by: adishaa <adishaa@amazon.com>
* docs: V3 documentation update (#5463)
* feat: Add comprehensive V3 documentation with enhanced UI
- Add complete documentation structure for SageMaker Python SDK V3
- Implement eye-catching card-based UI for 'What's New' section
- Position model customization as flagship V3 feature with prominent highlighting
- Add comprehensive content for training, inference, ML ops, and core modules
- Include collapsed navigation with model customization emphasis
- Set up ReadTheDocs configuration and Sphinx documentation system
- Add installation guide, quickstart, and overview pages
- Link to staging repository examples and notebooks
* feat: Add comprehensive feedback component with light theme
- Add thumbs up/down feedback buttons with SVG icons
- Show detailed feedback options when thumbs down is selected
- Include 5 checkbox options: hard to understand, code doesn't work, couldn't find, out of date, other
- Add textarea for additional feedback details
- Implement light theme styling with proper contrast
- Position component at bottom of each documentation page
- Include analytics tracking for feedback data
- Support multiple selection of feedback reasons
* Add API documentation using autodoc and autosummary
* doc: Documentation v3 improvements
* docs: Update requirements.txt for documentation build
* docs: Add sphinx-design to requirements.txt for ReadTheDocs build
* docs: Remove unsupported LoRAConfig/TrainingConfig and update preference_dataset to training_dataset
* doc: Update inference docs
* docs: Update ModelBuilder example in overview.rst with correct V3 workflow
* Clear Clarify notebook output
---------
Co-authored-by: adishaa <adishaa@amazon.com>
* doc: V3 documentation update (#5464)
* feat: Add comprehensive V3 documentation with enhanced UI
- Add complete documentation structure for SageMaker Python SDK V3
- Implement eye-catching card-based UI for 'What's New' section
- Position model customization as flagship V3 feature with prominent highlighting
- Add comprehensive content for training, inference, ML ops, and core modules
- Include collapsed navigation with model customization emphasis
- Set up ReadTheDocs configuration and Sphinx documentation system
- Add installation guide, quickstart, and overview pages
- Link to staging repository examples and notebooks
* feat: Add comprehensive feedback component with light theme
- Add thumbs up/down feedback buttons with SVG icons
- Show detailed feedback options when thumbs down is selected
- Include 5 checkbox options: hard to understand, code doesn't work, couldn't find, out of date, other
- Add textarea for additional feedback details
- Implement light theme styling with proper contrast
- Position component at bottom of each documentation page
- Include analytics tracking for feedback data
- Support multiple selection of feedback reasons
* Add API documentation using autodoc and autosummary
* doc: Documentation v3 improvements
* docs: Update requirements.txt for documentation build
* docs: Add sphinx-design to requirements.txt for ReadTheDocs build
* docs: Remove unsupported LoRAConfig/TrainingConfig and update preference_dataset to training_dataset
* doc: Update inference docs
* docs: Update ModelBuilder example in overview.rst with correct V3 workflow
* Clear Clarify notebook output
* Fix GitHub buttons and update V3 breaking changes note
- Fix duplicate html_theme_options in conf.py that was hiding GitHub repo and issues buttons
- Update overview note to mention V3 breaking changes and link to release notes
* doc: Update MLOps example notebook titles
* doc: Update notebook titles
* doc: Update model customization page
---------
Co-authored-by: adishaa <adishaa@amazon.com>
* V3 documentation update (#5468)
* feat: Add comprehensive V3 documentation with enhanced UI
- Add complete documentation structure for SageMaker Python SDK V3
- Implement eye-catching card-based UI for 'What's New' section
- Position model customization as flagship V3 feature with prominent highlighting
- Add comprehensive content for training, inference, ML ops, and core modules
- Include collapsed navigation with model customization emphasis
- Set up ReadTheDocs configuration and Sphinx documentation system
- Add installation guide, quickstart, and overview pages
- Link to staging repository examples and notebooks
* feat: Add comprehensive feedback component with light theme
- Add thumbs up/down feedback buttons with SVG icons
- Show detailed feedback options when thumbs down is selected
- Include 5 checkbox options: hard to understand, code doesn't work, couldn't find, out of date, other
- Add textarea for additional feedback details
- Implement light theme styling with proper contrast
- Position component at bottom of each documentation page
- Include analytics tracking for feedback data
- Support multiple selection of feedback reasons
* Add API documentation using autodoc and autosummary
* doc: Documentation v3 improvements
* docs: Update requirements.txt for documentation build
* docs: Add sphinx-design to requirements.txt for ReadTheDocs build
* docs: Remove unsupported LoRAConfig/TrainingConfig and update preference_dataset to training_dataset
* doc: Update inference docs
* docs: Update ModelBuilder example in overview.rst with correct V3 workflow
* Clear Clarify notebook output
* Fix GitHub buttons and update V3 breaking changes note
- Fix duplicate html_theme_options in conf.py that was hiding GitHub repo and issues buttons
- Update overview note to mention V3 breaking changes and link to release notes
* doc: Update MLOps example notebook titles
* doc: Update notebook titles
* doc: Update model customization page
* doc: Address latest feedback to bring parity with aws docs
* doc: fix what's new heading
---------
Co-authored-by: adishaa <adishaa@amazon.com>
* V3 documentation update (#5470)
* feat: Add comprehensive V3 documentation with enhanced UI
- Add complete documentation structure for SageMaker Python SDK V3
- Implement eye-catching card-based UI for 'What's New' section
- Position model customization as flagship V3 feature with prominent highlighting
- Add comprehensive content for training, inference, ML ops, and core modules
- Include collapsed navigation with model customization emphasis
- Set up ReadTheDocs configuration and Sphinx documentation system
- Add installation guide, quickstart, and overview pages
- Link to staging repository examples and notebooks
* feat: Add comprehensive feedback component with light theme
- Add thumbs up/down feedback buttons with SVG icons
- Show detailed feedback options when thumbs down is selected
- Include 5 checkbox options: hard to understand, code doesn't work, couldn't find, out of date, other
- Add textarea for additional feedback details
- Implement light theme styling with proper contrast
- Position component at bottom of each documentation page
- Include analytics tracking for feedback data
- Support multiple selection of feedback reasons
* Add API documentation using autodoc and autosummary
* doc: Documentation v3 improvements
* docs: Update requirements.txt for documentation build
* docs: Add sphinx-design to requirements.txt for ReadTheDocs build
* docs: Remove unsupported LoRAConfig/TrainingConfig and update preference_dataset to training_dataset
* doc: Update inference docs
* docs: Update ModelBuilder example in overview.rst with correct V3 workflow
* Clear Clarify notebook output
* Fix GitHub buttons and update V3 breaking changes note
- Fix duplicate html_theme_options in conf.py that was hiding GitHub repo and issues buttons
- Update overview note to mention V3 breaking changes and link to release notes
* doc: Update MLOps example notebook titles
* doc: Update notebook titles
* doc: Update model customization page
* doc: Address latest feedback to bring parity with aws docs
* doc: fix what's new heading
* doc: Reorganize model customization
---------
Co-authored-by: adishaa <adishaa@amazon.com>
* V3 documentation update (#5471)
* feat: Add comprehensive V3 documentation with enhanced UI
- Add complete documentation structure for SageMaker Python SDK V3
- Implement eye-catching card-based UI for 'What's New' section
- Position model customization as flagship V3 feature with prominent highlighting
- Add comprehensive content for training, inference, ML ops, and core modules
- Include collapsed navigation with model customization emphasis
- Set up ReadTheDocs configuration and Sphinx documentation system
- Add installation guide, quickstart, and overview pages
- Link to staging repository examples and notebooks
* feat: Add comprehensive feedback component with light theme
- Add thumbs up/down feedback buttons with SVG icons
- Show detailed feedback options when thumbs down is selected
- Include 5 checkbox options: hard to understand, code doesn't work, couldn't find, out of date, other
- Add textarea for additional feedback details
- Implement light theme styling with proper contrast
- Position component at bottom of each documentation page
- Include analytics tracking for feedback data
- Support multiple selection of feedback reasons
* Add API documentation using autodoc and autosummary
* doc: Documentation v3 improvements
* docs: Update requirements.txt for documentation build
* docs: Add sphinx-design to requirements.txt for ReadTheDocs build
* docs: Remove unsupported LoRAConfig/TrainingConfig and update preference_dataset to training_dataset
* doc: Update inference docs
* docs: Update ModelBuilder example in overview.rst with correct V3 workflow
* Clear Clarify notebook output
* Fix GitHub buttons and update V3 breaking changes note
- Fix duplicate html_theme_options in conf.py that was hiding GitHub repo and issues buttons
- Update overview note to mention V3 breaking changes and link to release notes
* doc: Update MLOps example notebook titles
* doc: Update notebook titles
* doc: Update model customization page
* doc: Address latest feedback to bring parity with aws docs
* doc: fix what's new heading
* doc: Reorganize model customization
* docs: Update headings
* doc: minor fix
* doc: Fix headings
---------
Co-authored-by: adishaa <adishaa@amazon.com>
---------
Co-authored-by: adishaa <adishaa@amazon.com>1 parent b2bb22e commit 1f6c645
File tree
40 files changed
+3387
-595
lines changed- docs
- _static
- api
- inference
- ml_ops
- model_customization
- sagemaker_core
- training
- v3-examples
- ml-ops-examples
- v3-model-registry-example
- v3-processing-job-pytorch
- model-customization-examples
40 files changed
+3387
-595
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
18 | 18 | | |
19 | 19 | | |
20 | 20 | | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
21 | 24 | | |
22 | 25 | | |
23 | 26 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
0 commit comments