Skip to content

Commit 1bae63c

Browse files
geyangclaude
andcommitted
Docs: Convert all RST documentation to Markdown
- Convert index.rst and all API documentation files to Markdown format - Reorganize documentation structure with comprehensive toctrees - Add new sections: Advanced Topics, Help - Include previously orphaned docs: architecture, deployment, faq, etc. - Keep RST support in conf.py for autodoc compatibility All documentation now uses Markdown (MyST) as the primary format while maintaining backward compatibility with RST for Sphinx autodoc. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent a4646d8 commit 1bae63c

File tree

11 files changed

+135
-105
lines changed

11 files changed

+135
-105
lines changed
Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
Client
2-
======
1+
# Client
32

3+
```{eval-rst}
44
.. automodule:: ml_dash.client
55
:members:
66
:undoc-members:
77
:show-inheritance:
8+
```
Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
Experiment
2-
==========
1+
# Experiment
32

3+
```{eval-rst}
44
.. automodule:: ml_dash.experiment
55
:members:
66
:undoc-members:
77
:show-inheritance:
8+
```
Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
Files
2-
=====
1+
# Files
32

3+
```{eval-rst}
44
.. automodule:: ml_dash.files
55
:members:
66
:undoc-members:
77
:show-inheritance:
8+
```
Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
Logging
2-
=======
1+
# Log
32

3+
```{eval-rst}
44
.. automodule:: ml_dash.log
55
:members:
66
:undoc-members:
77
:show-inheritance:
8+
```
Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
Metric
2-
=====
1+
# Metric
32

3+
```{eval-rst}
44
.. automodule:: ml_dash.metric
55
:members:
66
:undoc-members:
77
:show-inheritance:
8+
```

docs/api/modules.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# API Reference
2+
3+
This section contains the API documentation for the ML-Dash Python SDK.
4+
5+
## Core Modules
6+
7+
```{toctree}
8+
:maxdepth: 2
9+
10+
experiment
11+
client
12+
storage
13+
```
14+
15+
## Feature Modules
16+
17+
```{toctree}
18+
:maxdepth: 2
19+
20+
log
21+
params
22+
files
23+
metric
24+
```

docs/api/modules.rst

Lines changed: 0 additions & 25 deletions
This file was deleted.
Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
Parameters
2-
==========
1+
# Parameters
32

3+
```{eval-rst}
44
.. automodule:: ml_dash.params
55
:members:
66
:undoc-members:
77
:show-inheritance:
8+
```
Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
Storage
2-
=======
1+
# Storage
32

3+
```{eval-rst}
44
.. automodule:: ml_dash.storage
55
:members:
66
:undoc-members:
77
:show-inheritance:
8+
```

docs/index.md

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
# Welcome to ML-Dash
2+
3+
## Installation
4+
5+
```shell
6+
uv add ml-dash
7+
```
8+
9+
or using pip
10+
11+
```shell
12+
pip install ml-dash
13+
```
14+
15+
## Quick Example
16+
17+
```python
18+
from ml_dash import Experiment
19+
20+
with Experiment(name="my-experiment", project="my-project", local_path=".ml_dash") as experiment:
21+
# Log messages
22+
experiment.log("Training started")
23+
24+
# Metric parameters
25+
experiment.parameters().set(learning_rate=0.001, batch_size=32)
26+
27+
# Metric metrics
28+
experiment.metric("loss").append(value=0.5, epoch=1)
29+
```
30+
31+
```{toctree}
32+
:maxdepth: 2
33+
:caption: Getting Started
34+
:hidden:
35+
36+
overview
37+
quickstart
38+
getting-started
39+
```
40+
41+
```{toctree}
42+
:maxdepth: 2
43+
:caption: Tutorials
44+
:hidden:
45+
46+
experiments
47+
logging
48+
parameters
49+
metrics
50+
files
51+
```
52+
53+
```{toctree}
54+
:maxdepth: 2
55+
:caption: Examples
56+
:hidden:
57+
58+
examples
59+
basic-training
60+
hyperparameter-search
61+
model-comparison
62+
complete-examples
63+
```
64+
65+
```{toctree}
66+
:maxdepth: 2
67+
:caption: Advanced Topics
68+
:hidden:
69+
70+
local-vs-remote
71+
deployment
72+
architecture
73+
```
74+
75+
```{toctree}
76+
:maxdepth: 2
77+
:caption: API Reference
78+
:hidden:
79+
80+
api-quick-reference
81+
api/modules
82+
```
83+
84+
```{toctree}
85+
:maxdepth: 1
86+
:caption: Help
87+
:hidden:
88+
89+
faq
90+
```

0 commit comments

Comments
 (0)