From 489d288240d8123e6b28e4d995e68521a56249d4 Mon Sep 17 00:00:00 2001 From: Boris Feld Date: Tue, 17 Dec 2024 11:27:53 +0100 Subject: [PATCH] Update reference doc after following #868 (#903) --- .../{ExperimentItem.rst => ExperimentItemContent.rst} | 6 +++--- .../source/Objects/ExperimentItemReferences.rst | 7 +++++++ apps/opik-documentation/python-sdk-docs/source/index.rst | 3 ++- 3 files changed, 12 insertions(+), 4 deletions(-) rename apps/opik-documentation/python-sdk-docs/source/Objects/{ExperimentItem.rst => ExperimentItemContent.rst} (68%) create mode 100644 apps/opik-documentation/python-sdk-docs/source/Objects/ExperimentItemReferences.rst diff --git a/apps/opik-documentation/python-sdk-docs/source/Objects/ExperimentItem.rst b/apps/opik-documentation/python-sdk-docs/source/Objects/ExperimentItemContent.rst similarity index 68% rename from apps/opik-documentation/python-sdk-docs/source/Objects/ExperimentItem.rst rename to apps/opik-documentation/python-sdk-docs/source/Objects/ExperimentItemContent.rst index db3aa8ca8b..9e1b4956dd 100644 --- a/apps/opik-documentation/python-sdk-docs/source/Objects/ExperimentItem.rst +++ b/apps/opik-documentation/python-sdk-docs/source/Objects/ExperimentItemContent.rst @@ -1,7 +1,7 @@ -ExperimentItem -============== +ExperimentItemContent +===================== -.. autoclass:: opik.api_objects.experiment.experiment_item.ExperimentItem +.. autoclass:: opik.api_objects.experiment.experiment_item.ExperimentItemContent :members: :inherited-members: :special-members: __init__ diff --git a/apps/opik-documentation/python-sdk-docs/source/Objects/ExperimentItemReferences.rst b/apps/opik-documentation/python-sdk-docs/source/Objects/ExperimentItemReferences.rst new file mode 100644 index 0000000000..5b0a28889e --- /dev/null +++ b/apps/opik-documentation/python-sdk-docs/source/Objects/ExperimentItemReferences.rst @@ -0,0 +1,7 @@ +ExperimentItemReferences +======================== + +.. autoclass:: opik.api_objects.experiment.experiment_item.ExperimentItemReferences + :members: + :inherited-members: + :special-members: __init__ diff --git a/apps/opik-documentation/python-sdk-docs/source/index.rst b/apps/opik-documentation/python-sdk-docs/source/index.rst index fcc77db141..df38d11a03 100644 --- a/apps/opik-documentation/python-sdk-docs/source/index.rst +++ b/apps/opik-documentation/python-sdk-docs/source/index.rst @@ -205,7 +205,8 @@ You can learn more about the `opik` python SDK in the following sections: Objects/FeedbackScoreDict.rst Objects/UsageDict.rst Objects/Experiment.rst - Objects/ExperimentItem.rst + Objects/ExperimentItemContent.rst + Objects/ExperimentItemReferences.rst Objects/Prompt.rst Objects/OpikBaseModel.rst Objects/LiteLLMChatModel.rst