Skip to content

Commit 885bc1d

Browse files
python scaffold
Signed-off-by: Ashwin Vaidya <[email protected]>
1 parent ab1e88a commit 885bc1d

36 files changed

+391
-16
lines changed

docs/source/cpp/models/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,4 +208,4 @@
208208
./detection_model_retinaface_pt
209209
./openpose_decoder
210210
211-
```{toctree}
211+
```

docs/source/index.md

Lines changed: 80 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,87 @@
11
# InferenceSDK Documentation
22

3-
```{attention}
4-
WIP
5-
```
3+
## Python API Reference
4+
5+
::::{grid} 1 2 2 3
6+
:margin: 1 1 0 0
7+
:gutter: 1
8+
9+
:::{grid-item-card} {octicon}`plug` Adapters
10+
:link: ./python/adapters/index
11+
:link-type: doc
12+
13+
Adapters description[todo]
14+
:::
15+
16+
:::{grid-item-card} {octicon}`dependabot` Models
17+
:link: ./python/models/index
18+
:link-type: doc
19+
20+
Models description[todo]
21+
:::
22+
23+
:::{grid-item-card} {octicon}`git-compare` Pipelines
24+
:link: ./python/pipelines/index
25+
:link-type: doc
26+
27+
Pipelines description[todo]
28+
:::
29+
30+
:::{grid-item-card} {octicon}`versions` Tilers
31+
:link: ./python/tilers/index
32+
:link-type: doc
33+
34+
Tilers description[todo]
35+
:::
36+
37+
::::
38+
39+
## C++ API Reference
40+
41+
::::{grid} 1 2 2 3
42+
:margin: 1 1 0 0
43+
:gutter: 1
44+
45+
:::{grid-item-card} {octicon}`plug` Adapters
46+
:link: ./cpp/adapters/index
47+
:link-type: doc
48+
49+
Adapters description[todo]
50+
:::
51+
52+
:::{grid-item-card} {octicon}`dependabot` Models
53+
:link: ./cpp/models/index
54+
:link-type: doc
55+
56+
Models description[todo]
57+
:::
58+
59+
:::{grid-item-card} {octicon}`versions` Tilers
60+
:link: ./cpp/tilers/index
61+
:link-type: doc
62+
63+
Tilers description[todo]
64+
:::
65+
66+
:::{grid-item-card} {octicon}`tools` Utils
67+
:link: ./cpp/utils/index
68+
:link-type: doc
69+
70+
Pipelines description[todo]
71+
:::
72+
73+
::::
74+
75+
```{toctree}
76+
:caption: Python Reference
77+
:hidden:
678
7-
```{eval-rst}
8-
.. doxygenindex::
9-
:project: InferenceSDK
10-
:path: ...
11-
:outline:
12-
:no-link:
13-
:allow-dot-graphs:
79+
python/index
1480
```
1581

16-
```{eval-rst}
17-
.. automodule:: model_api.models
18-
:members:
19-
:undoc-members:
20-
:show-inheritance:
82+
```{toctree}
83+
:caption: C++ Reference
84+
:hidden:
2185
86+
cpp/index
2287
```
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Adapters

docs/source/python/index.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Python API Reference
2+
3+
::::{grid} 1 2 2 3
4+
:margin: 1 1 0 0
5+
:gutter: 1
6+
7+
:::{grid-item-card} {octicon}`plug` Adapters
8+
:link: adapters/index
9+
:link-type: doc
10+
11+
Adapters description[todo]
12+
:::
13+
14+
:::{grid-item-card} {octicon}`dependabot` Models
15+
:link: models/index
16+
:link-type: doc
17+
18+
Models description[todo]
19+
:::
20+
21+
:::{grid-item-card} {octicon}`git-compare` Pipelines
22+
:link: pipelines/index
23+
:link-type: doc
24+
25+
Pipelines description[todo]
26+
:::
27+
28+
:::{grid-item-card} {octicon}`versions` Tilers
29+
:link: tilers/index
30+
:link-type: doc
31+
32+
Tilers description[todo]
33+
:::
34+
35+
::::
36+
37+
```{toctree}
38+
:caption: Python Reference
39+
:hidden:
40+
41+
adapters/index
42+
models/index
43+
pipelines/index
44+
tilers/index
45+
```
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Action Classification
2+
3+
```{eval-rst}
4+
.. automodule:: model_api.models.action_classification
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
```
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Anomaly
2+
3+
```{eval-rst}
4+
.. automodule:: model_api.models.anomaly
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
```
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Background Matting

docs/source/python/models/bert.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Bert
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Centernet
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Classification

0 commit comments

Comments
 (0)