Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
2d29f1d
add Python API reference
paulb-seldon Aug 12, 2025
a27e303
remove inherited functions from generated docs
paulb-seldon Aug 12, 2025
382eb82
reduce generated classes / functions to those previously rendered
paulb-seldon Aug 12, 2025
f5da2d2
test previous sphinx approach
paulb-seldon Aug 13, 2025
67a8f45
Initial commit - update python api reference workflow
paulb-seldon Aug 14, 2025
a9def95
Merge remote, api docs
paulb-seldon Aug 14, 2025
69cc296
add settings and mlserver settings api reference draft
paulb-seldon Aug 15, 2025
a0859ca
return deleted files
paulb-seldon Aug 15, 2025
fc36fdc
add model and server settings to summary.
paulb-seldon Aug 15, 2025
f773e6f
update formatting for mlserver settings
paulb-seldon Aug 15, 2025
3e6b2a1
check fields formatting
paulb-seldon Aug 15, 2025
73dd705
replace deprecated markdown references
paulb-seldon Aug 15, 2025
bc80beb
Add space - formatting test
paulb-seldon Aug 15, 2025
4406734
Add space - formatting test 2
paulb-seldon Aug 15, 2025
155f730
add updated anchor settings
paulb-seldon Aug 15, 2025
403f82d
try html-based anchors
paulb-seldon Aug 15, 2025
840058a
add custom anchoring
paulb-seldon Aug 15, 2025
0812b82
reset automated formatting
paulb-seldon Aug 18, 2025
b6ef20e
use jinja formatting + autosummary
paulb-seldon Aug 19, 2025
0913e2c
add rendered files to summary
paulb-seldon Aug 19, 2025
4ec5428
test new class formatting for gb
paulb-seldon Aug 20, 2025
46a6a70
update summary with correct link
paulb-seldon Aug 20, 2025
f4dbaa4
gitbook formatting template change
paulb-seldon Aug 20, 2025
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
20 changes: 14 additions & 6 deletions docs-gb/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,22 @@
* [HuggingFace](runtimes/huggingface.md)
* [Custom](runtimes/custom.md)
* [Reference](reference/README.md)
* [MLServer Settings](reference/settings.md)
* [Model Settings](reference/model-settings.md)
* [MLServer CLI](reference/cli.md)
* [Python API](reference/python-api/README.md)
* [MLModel](reference/api/model.md)
* [Types](reference/api/types.md)
* [MLServer Settings](_build/markdown/settings.md)
* [Model Settings](_build/markdown/model-settings.md)
* [Python API](_reference/python-api_/README.md)
* [MLModel](_build/markdown/settings.md)
* [Model Settings](_build/markdown/model-settings.md)
* [Types](_build/markdown/types.md)
* [Codecs](reference/api/codecs.md)
* [Codecs — Built-ins](_build/markdown/codecs-builtins.md)
* [Codecs - Interfaces](_build/markdown/codecs-interfaces.md)
* [Metrics](reference/api/metrics.md)
* [Types Reference](_build/api_markdown/types.md)
* [mlserver.types](api/_build/api_markdown/_generated/mlserver.types.md)
* [InferenceRequest](api/_build/_autosummary/mlserver.types.InferenceRequest.md)
* [InferenceErrorResponse](api/_build/_autosummary/mlserver.types.InferenceErrorResponse.md)
* [Types All](_build/api_markdown/types_all.md)

* [Examples](examples/README.md)
* [Serving Scikit-Learn models](examples/sklearn/README.md)
* [Serving XGBoost models](examples/xgboost/README.md)
Expand Down
66 changes: 66 additions & 0 deletions docs-gb/api/_autosummary/mlserver.types.Datatype.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
Datatype
============

.. currentmodule:: mlserver.types

**Qualified name:** ``mlserver.types.Datatype``

Overview
--------
.. autoclass:: mlserver.types.Datatype
:noindex:
:member-order: bysource






















































122 changes: 122 additions & 0 deletions docs-gb/api/_autosummary/mlserver.types.InferenceErrorResponse.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
InferenceErrorResponse
============

.. currentmodule:: mlserver.types

**Qualified name:** ``mlserver.types.InferenceErrorResponse``

Overview
--------
.. autoclass:: mlserver.types.InferenceErrorResponse
:noindex:
:member-order: bysource






Constructor
-----------
.. automethod:: mlserver.types.InferenceErrorResponse.__init__
:noindex:




































































































131 changes: 131 additions & 0 deletions docs-gb/api/_autosummary/mlserver.types.InferenceRequest.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
InferenceRequest
============

.. currentmodule:: mlserver.types

**Qualified name:** ``mlserver.types.InferenceRequest``

Overview
--------
.. autoclass:: mlserver.types.InferenceRequest
:noindex:
:member-order: bysource






Constructor
-----------
.. automethod:: mlserver.types.InferenceRequest.__init__
:noindex:













































































































Loading
Loading