Skip to content

Commit

Permalink
docs: Fix SDK and Schema reference guide
Browse files Browse the repository at this point in the history
Signed-off-by: Dimitris Poulopoulos <[email protected]>
  • Loading branch information
dpoulopoulos committed Nov 20, 2024
1 parent ccb384b commit bbd7806
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
8 changes: 4 additions & 4 deletions docs/source/reference/schemas.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
Schemas
=======

.. automodule:: schemas.completions
.. automodule:: lumigator_schemas.completions
:members:

.. automodule:: schemas.datasets
.. automodule:: lumigator_schemas.datasets
:members:

.. automodule:: schemas.jobs
.. automodule:: lumigator_schemas.jobs
:members:

.. automodule:: schemas.extras
.. automodule:: lumigator_schemas.extras
:members:
12 changes: 6 additions & 6 deletions docs/source/reference/sdk.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Lumigator Client
The main entry point to the SDK is the `LumigatorClient` class. You can create an instance of this
class by providing the Lumigator API host and your Ray cluster address.

.. automodule:: sdk.lumigator
.. automodule:: lumigator_sdk.lumigator
:members:
:undoc-members:

Expand All @@ -21,7 +21,7 @@ Health
The `Health` class provides a simple interface to check the health of the Lumigator API and the
status of the Ray jobs running on the cluster.

.. automodule:: sdk.health
.. automodule:: lumigator_sdk.health
:members:
:undoc-members:

Expand All @@ -30,7 +30,7 @@ Datasets

The `Datasets` class provides a simple interface to create, update, delete, and list datasets.

.. automodule:: sdk.lm_datasets
.. automodule:: lumigator_sdk.lm_datasets
:members:
:undoc-members:

Expand All @@ -40,7 +40,7 @@ Jobs
The `Jobs` class provides a simple interface to submit and monitor jobs. Currently, we support two
types of jobs: Inference and Evaluation.

.. automodule:: sdk.jobs
.. automodule:: lumigator_sdk.jobs
:members:
:undoc-members:

Expand All @@ -50,7 +50,7 @@ Completions
The `Completions` class provides a simple interface to request completions from external APIs.
Currently, we support two APIs: OpenAI's and Mistral's.

.. automodule:: sdk.completions
.. automodule:: lumigator_sdk.completions
:members:
:undoc-members:

Expand All @@ -60,6 +60,6 @@ Base Client
The `BaseClient` class provides a base class for the LumigatorClient. You can use this class to
create your own client with custom methods.

.. automodule:: sdk.client
.. automodule:: lumigator_sdk.client
:members:
:undoc-members:

0 comments on commit bbd7806

Please sign in to comment.