Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: api reference overhaul modules #3872

Merged
merged 2 commits into from
Jul 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 12 additions & 2 deletions api_reference/source/_static/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@
justify-content: center;
}

/* .bd-article #api-definition h2 {
display: flex;
justify-content: center;
} */

#main-content > .bd-article > img {
display: flex;
justify-content: center;
Expand All @@ -18,12 +23,17 @@
justify-content: space-around;
}

#api-definition > .toctree-wrapper.compound > ul {
#arize-phoenix-api-reference > #api-definition > .toctree-wrapper > ul {
display: flex;
flex-direction: row;
justify-content: space-between;
flex-wrap: wrap;
}

#arize-phoenix-api-reference > #api-definition > .toctree-wrapper > ul > li {
padding: 1em 1em 1em 1em;
}

/* -- navbar display --------------------------------------------------------- */

.navbar-nav .nav-link {
Expand All @@ -39,7 +49,7 @@
background: var(--pst-color-surface);
}

.sig.sig-object.py .sig-param, .sig-paren{
.sig.sig-object.py .sig-param, .sig-paren {
font-weight: normal;
}

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 11 additions & 6 deletions api_reference/source/_static/switcher.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,19 @@
"url": "https://arize-phoenix.readthedocs.io/en/latest/"
},
{
"name": "4.6.2 (stable)",
"version": "v4.6.2",
"url": "https://arize-phoenix.readthedocs.io/en/arize-phoenix-v4.6.2/",
"name": "4.8.1",
"version": "v4.8.1",
"url": "https://arize-phoenix.readthedocs.io/en/arize-phoenix-v4.8.1/",
"preferred": true
},
{
"name": "4.6.1",
"version": "v4.6.1",
"url": "https://arize-phoenix.readthedocs.io/en/arize-phoenix-v4.6.1/"
"name": "4.8.0",
"version": "v4.8.0",
"url": "https://arize-phoenix.readthedocs.io/en/arize-phoenix-v4.8.0/"
},
{
"name": "4.7.2",
"version": "v4.7.2",
"url": "https://arize-phoenix.readthedocs.io/en/arize-phoenix-v4.7.2/"
}
]
16 changes: 7 additions & 9 deletions api_reference/source/api/client.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
client module
=====================

To import Client, use::

from phoenix import Client

----------
client
======
API reference for phoenix.Client, which helps you upload and download data to and from local or remote Phoenix servers.

phoenix.Client
--------
.. automodule:: session.client
:members:
:show-inheritance:
:special-members: __init__
:exclude-members: DatasetUploadError
18 changes: 0 additions & 18 deletions api_reference/source/api/client_package.rst

This file was deleted.

7 changes: 0 additions & 7 deletions api_reference/source/api/db.bulk_inserter.rst

This file was deleted.

7 changes: 0 additions & 7 deletions api_reference/source/api/db.engines.rst

This file was deleted.

7 changes: 0 additions & 7 deletions api_reference/source/api/db.helpers.rst

This file was deleted.

7 changes: 0 additions & 7 deletions api_reference/source/api/db.insertion.dataset.rst

This file was deleted.

7 changes: 0 additions & 7 deletions api_reference/source/api/db.insertion.evaluation.rst

This file was deleted.

7 changes: 0 additions & 7 deletions api_reference/source/api/db.insertion.helpers.rst

This file was deleted.

18 changes: 0 additions & 18 deletions api_reference/source/api/db.insertion.rst

This file was deleted.

7 changes: 0 additions & 7 deletions api_reference/source/api/db.insertion.span.rst

This file was deleted.

7 changes: 0 additions & 7 deletions api_reference/source/api/db.migrate.rst

This file was deleted.

7 changes: 0 additions & 7 deletions api_reference/source/api/db.migrations.env.rst

This file was deleted.

16 changes: 0 additions & 16 deletions api_reference/source/api/db.migrations.rst

This file was deleted.

7 changes: 0 additions & 7 deletions api_reference/source/api/db.migrations.types.rst

This file was deleted.

7 changes: 0 additions & 7 deletions api_reference/source/api/db.models.rst

This file was deleted.

24 changes: 0 additions & 24 deletions api_reference/source/api/db.rst

This file was deleted.

3 changes: 1 addition & 2 deletions api_reference/source/api/evals.classify.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ evals.classify
==============

.. automodule:: evals.classify
:members:
:show-inheritance:
:members:
:exclude-members: ClassificationStatus, RunEvalsPayload
:no-undoc-members:
1 change: 0 additions & 1 deletion api_reference/source/api/evals.evaluators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,5 @@ evals.evaluators

.. automodule:: evals.evaluators
:members:
:show-inheritance:
:exclude-members: MapReducer, Refiner
:no-undoc-members:
1 change: 0 additions & 1 deletion api_reference/source/api/evals.generate.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ evals.generate

.. automodule:: evals.generate
:members:
:show-inheritance:
:no-undoc-members:
1 change: 0 additions & 1 deletion api_reference/source/api/evals.models.anthropic.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,5 @@ evals.models.anthropic

.. automodule:: evals.models.anthropic
:members:
:show-inheritance:
:exclude-members: anthropic_version
:no-undoc-members:
2 changes: 0 additions & 2 deletions api_reference/source/api/evals.models.bedrock.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,4 @@ evals.models.bedrock

.. automodule:: evals.models.bedrock
:members:
:show-inheritance:
:no-undoc-members:

1 change: 0 additions & 1 deletion api_reference/source/api/evals.models.litellm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ evals.models.litellm

.. automodule:: evals.models.litellm
:members:
:show-inheritance:
:no-undoc-members:
1 change: 0 additions & 1 deletion api_reference/source/api/evals.models.mistralai.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,5 @@ evals.models.mistralai

.. automodule:: evals.models.mistralai
:members:
:show-inheritance:
:exclude-members: DEFAULT_MISTRAL_MODEL, MistralRateLimitError
:no-undoc-members:
1 change: 0 additions & 1 deletion api_reference/source/api/evals.models.openai.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,5 @@ evals.models.openai

.. automodule:: evals.models.openai
:members:
:show-inheritance:
:exclude-members: AzureOptions
:no-undoc-members:
1 change: 0 additions & 1 deletion api_reference/source/api/evals.models.vertex.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ evals.models.vertex

.. automodule:: evals.models.vertex
:members:
:show-inheritance:
:no-undoc-members:
1 change: 0 additions & 1 deletion api_reference/source/api/evals.models.vertexai.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,5 @@ evals.models.vertexai

.. automodule:: evals.models.vertexai
:members:
:show-inheritance:
:exclude-members: is_codey_model
:no-undoc-members:
1 change: 0 additions & 1 deletion api_reference/source/api/evals.retrievals.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,5 @@ evals.retrievals

.. automodule:: evals.retrievals
:members:
:show-inheritance:
:exclude-members: classify_relevance
:no-undoc-members:
4 changes: 2 additions & 2 deletions api_reference/source/api/evals.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
evals
evals
=====

.. toctree::
:maxdepth: 4
:maxdepth: 2

evals.models
evals.classify
Expand Down
1 change: 0 additions & 1 deletion api_reference/source/api/evals.templates.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ evals.templates

.. automodule:: evals.templates
:members:
:show-inheritance:
:exclude-members: InvalidClassificationTemplateError, PromptOptions, map_template, normalize_classification_template, normalize_prompt_template, parse_label_from_chain_of_thought_response
1 change: 0 additions & 1 deletion api_reference/source/api/evals.utils.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,5 @@ evals.utils

.. automodule:: evals.utils
:members:
:show-inheritance:
:exclude-members: get_tqdm_progress_bar_formatter, openai_function_call_kwargs, parse_openai_function_call, printif, snap_to_rail
:no-undoc-members:
7 changes: 0 additions & 7 deletions api_reference/source/api/experiments.evaluators.base.rst

This file was deleted.

This file was deleted.

This file was deleted.

18 changes: 0 additions & 18 deletions api_reference/source/api/experiments.evaluators.rst

This file was deleted.

Loading
Loading