Skip to content

Commit b5db660

Browse files
msaroufimmsaroufim
authored
Merge branch 'master' into msaroufim-patch-10
2 parents adb79e7 + 3815cda commit b5db660

20 files changed

+717
-3
lines changed

‎.github/workflows/doc-automation.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ jobs:
2424
python3 -m pip install katex
2525
python3 -m pip install sphinxcontrib.katex
2626
python3 -m pip install sphinx_markdown_tables
27+
python3 -m pip install torchserve torch-model-archiver torch-workflow-archiver
2728
- name: Build the docset
2829
run: cd ./docs/sphinx ; export PATH=$PATH:$(python3 -m site --user-base)/bin/ ; make html
2930
id: build

‎docs/api/dev_api.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. toctree::
2+
:caption: Developer APIs:
3+
4+
ts.rst
5+
ts.torch_handler.request_envelope.rst
6+
ts.torch_handler.rst
7+
ts.metrics.rst
8+
ts.model_service.rst
9+
ts.protocol.rst
10+
modules.rst
11+
12+
13+

‎docs/api/modules.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
serve
2+
=====
3+
4+
.. toctree::
5+
:maxdepth: 4
6+
7+
run_circleci_tests
8+
setup
9+
test
10+
torchserve_sanity
11+
ts
12+
ts_scripts

‎docs/api/run_circleci_tests.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
run\_circleci\_tests module
2+
===========================
3+
4+
.. automodule:: run_circleci_tests
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/api/setup.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
setup module
2+
============
3+
4+
.. automodule:: setup
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/api/test.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
test package
2+
============
3+
4+
Submodules
5+
----------
6+
7+
test.regression\_tests module
8+
-----------------------------
9+
10+
.. automodule:: test.regression_tests
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
16+
Module contents
17+
---------------
18+
19+
.. automodule:: test
20+
:members:
21+
:undoc-members:
22+
:show-inheritance:

‎docs/api/torchserve_sanity.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
torchserve\_sanity module
2+
=========================
3+
4+
.. automodule:: torchserve_sanity
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

‎docs/api/ts.metrics.rst

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
ts.metrics package
2+
==================
3+
4+
Submodules
5+
----------
6+
7+
ts.metrics.dimension module
8+
---------------------------
9+
10+
.. automodule:: ts.metrics.dimension
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
ts.metrics.metric module
16+
------------------------
17+
18+
.. automodule:: ts.metrics.metric
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
ts.metrics.metric\_collector module
24+
-----------------------------------
25+
26+
.. automodule:: ts.metrics.metric_collector
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
ts.metrics.metric\_encoder module
32+
---------------------------------
33+
34+
.. automodule:: ts.metrics.metric_encoder
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
ts.metrics.metrics\_store module
40+
--------------------------------
41+
42+
.. automodule:: ts.metrics.metrics_store
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
ts.metrics.process\_memory\_metric module
48+
-----------------------------------------
49+
50+
.. automodule:: ts.metrics.process_memory_metric
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
54+
55+
ts.metrics.system\_metrics module
56+
---------------------------------
57+
58+
.. automodule:: ts.metrics.system_metrics
59+
:members:
60+
:undoc-members:
61+
:show-inheritance:
62+
63+
ts.metrics.unit module
64+
----------------------
65+
66+
.. automodule:: ts.metrics.unit
67+
:members:
68+
:undoc-members:
69+
:show-inheritance:
70+
71+
72+
Module contents
73+
---------------
74+
75+
.. automodule:: ts.metrics
76+
:members:
77+
:undoc-members:
78+
:show-inheritance:

‎docs/api/ts.model_service.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
ts.model\_service package
2+
=========================
3+
4+
Submodules
5+
----------
6+
7+
ts.model\_service.model\_service module
8+
---------------------------------------
9+
10+
.. automodule:: ts.model_service.model_service
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
16+
Module contents
17+
---------------
18+
19+
.. automodule:: ts.model_service
20+
:members:
21+
:undoc-members:
22+
:show-inheritance:

‎docs/api/ts.protocol.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
ts.protocol package
2+
===================
3+
4+
Submodules
5+
----------
6+
7+
ts.protocol.otf\_message\_handler module
8+
----------------------------------------
9+
10+
.. automodule:: ts.protocol.otf_message_handler
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
16+
Module contents
17+
---------------
18+
19+
.. automodule:: ts.protocol
20+
:members:
21+
:undoc-members:
22+
:show-inheritance:

0 commit comments

Comments
 (0)