documentation: PySDK V3 Documentation #5472
Merged
+3,387
−595
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- 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>
…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>
- 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>
* 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>
* 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>
* 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>
* 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>
* 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>
* 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>
* 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>
* 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>
nargokul
approved these changes
Jan 9, 2026
jam-jee
approved these changes
Jan 9, 2026
Aditi2424
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue #, if available:
Description of changes:
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.