Skip to content
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
c846cde
feat: Add basic V3 documentation structure and configuration (#5445)
Aditi2424 Dec 31, 2025
6abbe37
doc: Add content for V3 training, inference, model customization, ml_…
Aditi2424 Dec 31, 2025
6a661c0
feat: Add comprehensive V3 documentation with enhanced UI
adishaa Dec 31, 2025
ce413a7
feat: Add comprehensive feedback component with light theme
adishaa Jan 1, 2026
77c229f
Add API documentation using autodoc and autosummary
adishaa Jan 2, 2026
222b5cf
doc: Add comprehensive V3 documentation with enhanced UI (#5448)
Aditi2424 Jan 2, 2026
7102981
Merge branch 'v3docs' into v3-documentation-update
Aditi2424 Jan 2, 2026
f8bde2f
doc: V3 documentation feedback component and API documentation (#5450)
Aditi2424 Jan 2, 2026
a8c3db8
doc: Documentation v3 improvements
adishaa Jan 5, 2026
c2b8857
Merge branch 'v3docs' into v3-documentation-update
Aditi2424 Jan 5, 2026
04b36f6
docs: Update requirements.txt for documentation build
adishaa Jan 5, 2026
7c950a7
docs: Add sphinx-design to requirements.txt for ReadTheDocs build
adishaa Jan 5, 2026
6b995e0
doc: V3 documentation update (#5452)
Aditi2424 Jan 5, 2026
deeaaa3
docs: Remove unsupported LoRAConfig/TrainingConfig and update prefere…
adishaa Jan 6, 2026
ed5f5d6
doc: Update inference docs
adishaa Jan 6, 2026
2a9da04
doc: Update Inference and Model Customization docs (#5454)
Aditi2424 Jan 6, 2026
73cd3cd
docs: Update ModelBuilder example in overview.rst with correct V3 wor…
adishaa Jan 6, 2026
0679027
Clear Clarify notebook output
adishaa Jan 7, 2026
f944d8f
Merge branch 'v3docs' into v3-documentation-update
Aditi2424 Jan 7, 2026
cd3df54
docs: V3 documentation update (#5463)
Aditi2424 Jan 7, 2026
b7ea1c5
Fix GitHub buttons and update V3 breaking changes note
adishaa Jan 7, 2026
07f4cf6
doc: Update MLOps example notebook titles
adishaa Jan 7, 2026
ac718a0
doc: Update notebook titles
adishaa Jan 7, 2026
4a22223
doc: Update model customization page
adishaa Jan 7, 2026
17ab110
doc: V3 documentation update (#5464)
Aditi2424 Jan 7, 2026
e8236e2
doc: Address latest feedback to bring parity with aws docs
adishaa Jan 8, 2026
e577af4
doc: fix what's new heading
adishaa Jan 8, 2026
26e0658
Merge branch 'v3docs' into v3-documentation-update
Aditi2424 Jan 8, 2026
fd64be6
V3 documentation update (#5468)
Aditi2424 Jan 8, 2026
1d21dcb
doc: Reorganize model customization
adishaa Jan 8, 2026
23f43d8
V3 documentation update (#5470)
Aditi2424 Jan 8, 2026
6ef4d92
docs: Update headings
adishaa Jan 8, 2026
f396883
Merge branch 'v3docs' into v3-documentation-update
Aditi2424 Jan 8, 2026
0387e27
doc: minor fix
adishaa Jan 8, 2026
e5403cb
doc: Fix headings
adishaa Jan 8, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ scratch/
*.egg
examples/tensorflow/distributed_mnist/data
*.iml

# Sphinx documentation
docs/_build/
doc/_build
doc/_static
doc/_templates
Expand Down
20 changes: 20 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
version: 2

build:
os: ubuntu-22.04
tools:
python: "3.10"

python:
install:
- method: pip
path: .
- requirements: docs/requirements.txt

sphinx:
configuration: docs/conf.py
fail_on_warning: false

formats:
- pdf
- epub
12 changes: 12 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = _build

help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
345 changes: 345 additions & 0 deletions docs/_static/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,345 @@
/* What's New Section Styling */
.whats-new-container {
display: grid;
grid-template-columns: repeat(auto-fit, minmax(300px, 1fr));
gap: 20px;
margin: 30px 0;
}

.new-feature-card {
background: linear-gradient(135deg, #f8f9fa 0%, #e9ecef 100%);
border: 1px solid #dee2e6;
border-radius: 12px;
padding: 25px;
box-shadow: 0 4px 12px rgba(0, 0, 0, 0.1);
transition: transform 0.2s ease, box-shadow 0.2s ease;
position: relative;
overflow: hidden;
}

.new-feature-card:hover {
transform: translateY(-2px);
box-shadow: 0 8px 25px rgba(0, 0, 0, 0.15);
}

.new-feature-card.exclusive {
background: linear-gradient(135deg, #ff6b6b 0%, #4ecdc4 100%);
color: white;
border: 2px solid #ff4757;
}

.new-feature-card.exclusive::before {
content: "V3 EXCLUSIVE";
position: absolute;
top: 10px;
right: -30px;
background: #ff4757;
color: white;
padding: 5px 40px;
font-size: 0.75em;
font-weight: bold;
transform: rotate(45deg);
box-shadow: 0 2px 5px rgba(0, 0, 0, 0.2);
}

.feature-icon {
font-size: 2.5em;
margin-bottom: 15px;
display: block;
}

.new-feature-card h3 {
margin-top: 0;
margin-bottom: 15px;
font-size: 1.3em;
font-weight: 600;
}

.new-feature-card.exclusive h3 {
color: white;
}

.new-feature-card ul {
margin: 15px 0;
padding-left: 20px;
}

.new-feature-card li {
margin-bottom: 8px;
line-height: 1.5;
}

.new-feature-card code {
background: rgba(0, 0, 0, 0.1);
padding: 2px 6px;
border-radius: 4px;
font-size: 0.9em;
}

.new-feature-card.exclusive code {
background: rgba(255, 255, 255, 0.2);
color: white;
}

/* Collapse navigation tree items by default */
.bd-toc .toctree-l1 > ul {
display: none;
}

.bd-toc .toctree-l1.current > ul {
display: block;
}

.bd-toc .toctree-l2 > ul {
display: none;
}

.bd-toc .toctree-l2.current > ul {
display: block;
}

/* Highlight model customization in navigation */
.bd-toc a[href*="model_customization"],
.toctree-l1 a[href*="model_customization"] {
background: linear-gradient(90deg, rgba(255, 107, 107, 0.15), rgba(78, 205, 196, 0.15));
border-left: 4px solid #ff6b6b;
padding-left: 12px;
font-weight: 600;
border-radius: 4px;
margin: 2px 0;
display: block;
}

.bd-toc a[href*="model_customization"]:before,
.toctree-l1 a[href*="model_customization"]:before {
content: "⭐ ";
color: #ff4757;
font-size: 0.9em;
}

/* Feedback Component */
.feedback-container {
border-top: 1px solid #e1e5e9;
margin-top: 40px;
padding: 24px;
background-color: #f8f9fa;
border-radius: 8px;
border: 1px solid #e1e5e9;
}

.feedback-question {
font-size: 20px;
font-weight: 500;
color: #374151;
margin-bottom: 20px;
text-align: left;
}

.feedback-buttons {
display: flex;
justify-content: flex-start;
gap: 12px;
}

.feedback-btn {
display: flex;
align-items: center;
gap: 8px;
padding: 8px 16px;
border: 1px solid #d1d5db;
border-radius: 6px;
background: white;
color: #6b7280;
font-size: 14px;
cursor: pointer;
transition: all 0.2s ease;
}

.feedback-btn:hover {
border-color: #9ca3af;
background: #f9fafb;
}

.feedback-btn.selected {
border-color: #3b82f6;
background: #eff6ff;
color: #1d4ed8;
}

.feedback-btn svg {
width: 16px;
height: 16px;
}

.feedback-thanks {
display: none;
color: #059669;
font-size: 14px;
text-align: center;
margin-top: 16px;
}

/* Feedback Options */
.feedback-options {
display: none;
margin-top: 20px;
}

.feedback-options-title {
font-size: 16px;
font-weight: 500;
color: #374151;
margin-bottom: 16px;
}

.required {
color: #ff6b6b;
}

.feedback-checkboxes {
display: flex;
flex-direction: column;
gap: 12px;
margin-bottom: 20px;
}

.feedback-checkbox {
display: flex;
align-items: center;
cursor: pointer;
color: #374151;
font-size: 14px;
position: relative;
padding-left: 32px;
}

.feedback-checkbox input[type="checkbox"] {
position: absolute;
opacity: 0;
cursor: pointer;
height: 0;
width: 0;
}

.checkmark {
position: absolute;
left: 0;
top: 2px;
height: 18px;
width: 18px;
background-color: transparent;
border: 2px solid #6b7280;
border-radius: 3px;
}

.feedback-checkbox:hover input ~ .checkmark {
border-color: #9ca3af;
}

.feedback-checkbox input:checked ~ .checkmark {
background-color: #3b82f6;
border-color: #3b82f6;
}

.checkmark:after {
content: "";
position: absolute;
display: none;
}

.feedback-checkbox input:checked ~ .checkmark:after {
display: block;
}

.feedback-checkbox .checkmark:after {
left: 5px;
top: 2px;
width: 4px;
height: 8px;
border: solid white;
border-width: 0 2px 2px 0;
transform: rotate(45deg);
}

.feedback-more {
display: flex;
flex-direction: column;
gap: 12px;
}

.feedback-more-title {
font-size: 16px;
font-weight: 500;
color: #374151;
}

.feedback-textarea {
padding: 12px;
border: 1px solid #d1d5db;
border-radius: 6px;
font-size: 14px;
resize: vertical;
min-height: 80px;
font-family: inherit;
background-color: #ffffff;
color: #374151;
}

.feedback-textarea::placeholder {
color: #6b7280;
}

.feedback-textarea:focus {
outline: none;
border-color: #3b82f6;
box-shadow: 0 0 0 3px rgba(59, 130, 246, 0.1);
}

.feedback-submit-btn {
padding: 10px 20px;
background: #3b82f6;
color: white;
border: none;
border-radius: 6px;
font-size: 14px;
font-weight: 500;
cursor: pointer;
align-self: flex-start;
transition: background 0.2s;
}

.feedback-submit-btn:hover {
background: #2563eb;
}

header {
background-color: white;

box-shadow: 0 1px 2px rgba(0, 0, 0, 0.05);
position: sticky;
top: 0;
z-index: 50;
}

h1 {
font-size: 1.875rem;
font-weight: 700;
color: #111827;
}

h2 {
font-size: 1.5rem;
font-weight: 700;
color: #111827;
}

h3 {
font-size: 1.25rem;
font-weight: 500;
color: #111827;
}

p {
font-size: 1.0rem;
color: #4b5563;
}
Loading
Loading