Skip to content

Commit

Permalink
docs: Navbar changes (GITBOOK-884)
Browse files Browse the repository at this point in the history
  • Loading branch information
Jgilhuly authored and gitbook-bot committed Oct 10, 2024
1 parent b00def9 commit 62798ad
Show file tree
Hide file tree
Showing 8 changed files with 11 additions and 11 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

* [Arize Phoenix](README.md)
* [Quickstart](quickstart.md)
* [Hosted Phoenix](hosted-phoenix.md)
* [User Guide](user-guide.md)
* [Examples](notebooks.md)
* [Setup](setup/README.md)
Expand All @@ -11,9 +10,10 @@
* [Authentication](setup/authentication.md)
* [Deployment](deployment/README.md)
* [Quickstart: Deployment](deployment/deploying-phoenix.md)
* [Hosted Phoenix](deployment/hosted-phoenix.md)
* [Docker](deployment/docker.md)
* [Persistence](deployment/persistence.md)
* [Kubernetes](deployment/kubernetes.md)
* [Docker](deployment/docker.md)
* [FAQs: Deployment](deployment/faqs-deployment.md)

## 🔭 Tracing
Expand Down
2 changes: 1 addition & 1 deletion docs/deployment/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: How to self-host a phoenix instance

Phoenix can natively be run as a container that collects traces and evaluations as you run them.

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td></td><td>Quickstart</td><td>How to deploy an LLM application with Phoenix observability</td><td><a href="../.gitbook/assets/quickstart.png">quickstart.png</a></td><td><a href="deploying-phoenix.md">deploying-phoenix.md</a></td></tr><tr><td></td><td>Persistence</td><td>How to setup a persistent disc or database</td><td><a href="../.gitbook/assets/persistence.png">persistence.png</a></td><td><a href="persistence.md">persistence.md</a></td></tr><tr><td></td><td>Kubernetes</td><td>How to deploy Phoenix on K8s</td><td><a href="../.gitbook/assets/k8s.png">k8s.png</a></td><td><a href="kubernetes.md">kubernetes.md</a></td></tr><tr><td></td><td>Docker</td><td>How to deploy Phoenix using Docker</td><td><a href="../.gitbook/assets/docker.png">docker.png</a></td><td><a href="docker.md">docker.md</a></td></tr></tbody></table>
<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td></td><td>Quickstart</td><td>How to deploy an LLM application with Phoenix observability</td><td><a href="../.gitbook/assets/quickstart.png">quickstart.png</a></td><td><a href="deploying-phoenix.md">deploying-phoenix.md</a></td></tr><tr><td>Hosted Phoenix</td><td>Access a serverless instance of Phoenix through our website</td><td></td><td><a href="../.gitbook/assets/Screenshot 2024-10-09 at 6.34.18 PM.png">Screenshot 2024-10-09 at 6.34.18 PM.png</a></td><td><a href="hosted-phoenix.md">hosted-phoenix.md</a></td></tr><tr><td></td><td>Persistence</td><td>How to setup a persistent disc or database</td><td><a href="../.gitbook/assets/persistence.png">persistence.png</a></td><td><a href="persistence.md">persistence.md</a></td></tr><tr><td></td><td>Kubernetes</td><td>How to deploy Phoenix on K8s</td><td><a href="../.gitbook/assets/k8s.png">k8s.png</a></td><td><a href="kubernetes.md">kubernetes.md</a></td></tr><tr><td></td><td>Docker</td><td>How to deploy Phoenix using Docker</td><td><a href="../.gitbook/assets/docker.png">docker.png</a></td><td><a href="docker.md">docker.md</a></td></tr></tbody></table>

## Images

Expand Down
6 changes: 3 additions & 3 deletions docs/hosted-phoenix.md → docs/deployment/hosted-phoenix.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,15 @@ We also use 3rd party analytics tools to measure usage of our application to imp

Click signup on [phoenix.arize.com](https://app.phoenix.arize.com). We offer logins via Google, Github, and email. This account will use the same account credentials as your Arize account if you have one.

<figure><img src=".gitbook/assets/image (1).png" alt=""><figcaption></figcaption></figure>
<figure><img src="../.gitbook/assets/image (1).png" alt=""><figcaption></figcaption></figure>

### Tracing: How to send in your first trace

<figure><img src=".gitbook/assets/image.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../.gitbook/assets/image.png" alt=""><figcaption></figcaption></figure>

Get your API keys from your Phoenix application on the left hand side.&#x20;

Here's the full sample code to trace a LlamaIndex and OpenAI application. Using a different framework? Hosted Phoenix works with [all of our automatic tracing options](tracing/how-to-tracing/instrumentation/) as well.
Here's the full sample code to trace a LlamaIndex and OpenAI application. Using a different framework? Hosted Phoenix works with [all of our automatic tracing options](../tracing/how-to-tracing/instrumentation/) as well.

{% tabs %}
{% tab title="LlamaIndex" %}
Expand Down
6 changes: 3 additions & 3 deletions docs/notebooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ description: Explore the capabilities of Phoenix with notebooks

## Tutorials

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>LLM Ops - Tracing, Evaluation, and Analysis</strong></td><td><a href=".gitbook/assets/Screenshot 2023-09-27 at 1.51.45 PM.png">Screenshot 2023-09-27 at 1.51.45 PM.png</a></td><td><a href="https://colab.research.google.com/github/Arize-ai/phoenix/blob/main/tutorials/llm_ops_overview.ipynb">https://colab.research.google.com/github/Arize-ai/phoenix/blob/main/tutorials/llm_ops_overview.ipynb</a></td></tr><tr><td><strong>Embedding Analysis - Search and Retrieval</strong></td><td><a href=".gitbook/assets/Screenshot 2023-09-27 at 1.53.06 PM.png">Screenshot 2023-09-27 at 1.53.06 PM.png</a></td><td><a href="https://colab.research.google.com/github/Arize-ai/phoenix/blob/main/tutorials/llama_index_search_and_retrieval_tutorial.ipynb">https://colab.research.google.com/github/Arize-ai/phoenix/blob/main/tutorials/llama_index_search_and_retrieval_tutorial.ipynb</a></td></tr><tr><td><strong>Evaluation - Evaluating a RAG pipeline</strong></td><td><a href=".gitbook/assets/retriever_span_with_evals.png">retriever_span_with_evals.png</a></td><td><a href="https://colab.research.google.com/github/Arize-ai/phoenix/blob/main/tutorials/evals/evaluate_rag.ipynb">https://colab.research.google.com/github/Arize-ai/phoenix/blob/main/tutorials/evals/evaluate_rag.ipynb</a></td></tr><tr><td><strong>Embedding Analysis - Embedding drift</strong></td><td><a href=".gitbook/assets/umap_drift.png">umap_drift.png</a></td><td><a href="https://colab.research.google.com/github/Arize-ai/phoenix/blob/main/tutorials/image_classification_tutorial.ipynb">https://colab.research.google.com/github/Arize-ai/phoenix/blob/main/tutorials/image_classification_tutorial.ipynb</a></td></tr></tbody></table>
<table data-card-size="large" data-view="cards"><thead><tr><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>LLM Ops - Tracing, Evaluation, and Analysis</strong></td><td><a href=".gitbook/assets/Screenshot 2023-09-27 at 1.51.45 PM.png">Screenshot 2023-09-27 at 1.51.45 PM.png</a></td><td><a href="https://colab.research.google.com/github/Arize-ai/phoenix/blob/main/tutorials/llm_ops_overview.ipynb">https://colab.research.google.com/github/Arize-ai/phoenix/blob/main/tutorials/llm_ops_overview.ipynb</a></td></tr><tr><td><strong>Evaluation - Evaluating a RAG pipeline</strong></td><td><a href=".gitbook/assets/retriever_span_with_evals.png">retriever_span_with_evals.png</a></td><td><a href="https://colab.research.google.com/github/Arize-ai/phoenix/blob/main/tutorials/evals/evaluate_rag.ipynb">https://colab.research.google.com/github/Arize-ai/phoenix/blob/main/tutorials/evals/evaluate_rag.ipynb</a></td></tr><tr><td><strong>Embedding Analysis - Search and Retrieval</strong></td><td><a href=".gitbook/assets/Screenshot 2023-09-27 at 1.53.06 PM.png">Screenshot 2023-09-27 at 1.53.06 PM.png</a></td><td><a href="https://colab.research.google.com/github/Arize-ai/phoenix/blob/main/tutorials/llama_index_search_and_retrieval_tutorial.ipynb">https://colab.research.google.com/github/Arize-ai/phoenix/blob/main/tutorials/llama_index_search_and_retrieval_tutorial.ipynb</a></td></tr><tr><td><strong>Embedding Analysis - Embedding drift</strong></td><td><a href=".gitbook/assets/umap_drift.png">umap_drift.png</a></td><td><a href="https://colab.research.google.com/github/Arize-ai/phoenix/blob/main/tutorials/image_classification_tutorial.ipynb">https://colab.research.google.com/github/Arize-ai/phoenix/blob/main/tutorials/image_classification_tutorial.ipynb</a></td></tr></tbody></table>

## Application Examples

Example full-stack applications instrumented using OpenInference and observed via phoenix server instances.

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Python</strong></td><td>LlamaIndex, Fast API Instrumentation</td><td><a href=".gitbook/assets/python.png">python.png</a></td><td><a href="https://github.com/Arize-ai/openinference/tree/main/python/examples">https://github.com/Arize-ai/openinference/tree/main/python/examples</a></td></tr><tr><td><strong>Javascript</strong></td><td>OpenAI, Express, Next.JS</td><td><a href=".gitbook/assets/javascript.png">javascript.png</a></td><td><a href="https://github.com/Arize-ai/openinference/tree/main/js/examples">https://github.com/Arize-ai/openinference/tree/main/js/examples</a></td></tr><tr><td><strong>DSPy</strong></td><td>DSPy, Fast API Instrumentation</td><td><a href=".gitbook/assets/dspy_tiled.png">dspy_tiled.png</a></td><td><a href="https://github.com/Arize-ai/openinference/tree/main/python/examples/dspy-rag-fastapi">https://github.com/Arize-ai/openinference/tree/main/python/examples/dspy-rag-fastapi</a></td></tr><tr><td><strong>TypeScript Chatbot with User Feedback</strong></td><td>OpenAI, Express, Next.JS</td><td><a href=".gitbook/assets/ts-chatbot-with-annotations.png">ts-chatbot-with-annotations.png</a></td><td><a href="https://github.com/Arize-ai/openinference/tree/main/js/examples/openai">https://github.com/Arize-ai/openinference/tree/main/js/examples/openai</a></td></tr><tr><td><strong>Python Chatbot with User Feedback</strong></td><td>OpenAI, Streamlit </td><td><a href=".gitbook/assets/python-chatbot-with-annotations.png">python-chatbot-with-annotations.png</a></td><td><a href="https://github.com/Arize-ai/phoenix/tree/main/examples/manually-instrumented-chatbot">https://github.com/Arize-ai/phoenix/tree/main/examples/manually-instrumented-chatbot</a></td></tr></tbody></table>
<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Python</strong></td><td>LlamaIndex, Fast API Instrumentation</td><td><a href=".gitbook/assets/python.png">python.png</a></td><td><a href="https://github.com/Arize-ai/openinference/tree/main/python/examples">https://github.com/Arize-ai/openinference/tree/main/python/examples</a></td></tr><tr><td><strong>Javascript</strong></td><td>OpenAI, Express, Next.JS</td><td><a href=".gitbook/assets/javascript.png">javascript.png</a></td><td><a href="https://github.com/Arize-ai/openinference/tree/main/js/examples">https://github.com/Arize-ai/openinference/tree/main/js/examples</a></td></tr><tr><td><strong>DSPy</strong></td><td>DSPy, Fast API Instrumentation</td><td><a href=".gitbook/assets/dspy_tiled.png">dspy_tiled.png</a></td><td><a href="https://github.com/Arize-ai/openinference/tree/main/python/examples/dspy-rag-fastapi">https://github.com/Arize-ai/openinference/tree/main/python/examples/dspy-rag-fastapi</a></td></tr><tr><td><strong>TypeScript Chatbot with User Feedback</strong></td><td>OpenAI, Express, Next.JS</td><td><a href=".gitbook/assets/ts-chatbot-with-annotations.png">ts-chatbot-with-annotations.png</a></td><td><a href="https://github.com/Arize-ai/openinference/tree/main/js/examples/openai">https://github.com/Arize-ai/openinference/tree/main/js/examples/openai</a></td></tr><tr><td><strong>Python Chatbot with User Feedback</strong></td><td>OpenAI, Streamlit</td><td><a href=".gitbook/assets/python-chatbot-with-annotations.png">python-chatbot-with-annotations.png</a></td><td><a href="https://github.com/Arize-ai/phoenix/tree/main/examples/manually-instrumented-chatbot">https://github.com/Arize-ai/phoenix/tree/main/examples/manually-instrumented-chatbot</a></td></tr></tbody></table>

## LLM Traces

Expand All @@ -25,7 +25,7 @@ Trace through the execution of your LLM application to understand its internal s
| Tracing and Evaluating a LlamaIndex OpenAI Agent | <ul><li>LlamaIndex</li><li>OpenAI</li><li>agents</li><li>function calling</li></ul> | [![Open in Colab](https://img.shields.io/static/v1?message=Open%20in%20Colab\&logo=googlecolab\&labelColor=grey\&color=blue\&logoColor=orange\&label=%20)](https://colab.research.google.com/github/Arize-ai/phoenix/blob/main/tutorials/tracing/llama\_index\_openai\_agent\_tracing\_tutorial.ipynb) [![Open in GitHub](https://img.shields.io/static/v1?message=Open%20in%20GitHub\&logo=github\&labelColor=grey\&color=blue\&logoColor=white\&label=%20)](https://github.com/Arize-ai/phoenix/blob/main/tutorials/tracing/llama\_index\_openai\_agent\_tracing\_tutorial.ipynb) |
| Tracing and Evaluating a Structured Data Extraction Application with OpenAI Function Calling | <ul><li>OpenAI</li><li>structured data extraction</li><li>function calling</li></ul> | [![Open in Colab](https://img.shields.io/static/v1?message=Open%20in%20Colab\&logo=googlecolab\&labelColor=grey\&color=blue\&logoColor=orange\&label=%20)](https://colab.research.google.com/github/Arize-ai/phoenix/blob/main/tutorials/tracing/openai\_tracing\_tutorial.ipynb) [![Open in GitHub](https://img.shields.io/static/v1?message=Open%20in%20GitHub\&logo=github\&labelColor=grey\&color=blue\&logoColor=white\&label=%20)](https://github.com/Arize-ai/phoenix/blob/main/tutorials/tracing/openai\_tracing\_tutorial.ipynb) |
| Tracing and Evaluating a LangChain + OpenAI RAG Application | <ul><li>LangChain</li><li>OpenAI</li><li>retrieval-augmented generation</li></ul> | [![Open in Colab](https://img.shields.io/static/v1?message=Open%20in%20Colab\&logo=googlecolab\&labelColor=grey\&color=blue\&logoColor=orange\&label=%20)](https://colab.research.google.com/github/Arize-ai/phoenix/blob/main/tutorials/tracing/langchain\_tracing\_tutorial.ipynb) [![Open in GitHub](https://img.shields.io/static/v1?message=Open%20in%20GitHub\&logo=github\&labelColor=grey\&color=blue\&logoColor=white\&label=%20)](https://github.com/Arize-ai/phoenix/blob/main/tutorials/tracing/langchain\_tracing\_tutorial.ipynb) |
| Tracing and Evaluating a LangChain Agent | <ul><li>LangChain</li><li>OpenAI</li><li>agents</li><li>function calling</li></ul> | [![Open in Colab](https://img.shields.io/static/v1?message=Open%20in%20Colab\&logo=googlecolab\&labelColor=grey\&color=blue\&logoColor=orange\&label=%20)](https://colab.research.google.com/github/Arize-ai/phoenix/blob/main/tutorials/tracing/langchain\_agent\_tracing\_tutorial.ipynb) [![Open in GitHub](https://img.shields.io/static/v1?message=Open%20in%20GitHub\&logo=github\&labelColor=grey\&color=blue\&logoColor=white\&label=%20)](https://github.com/Arize-ai/phoenix/blob/main/tutorials/tracing/langchain\_agent\_tracing\_tutorial.ipynb) | |
| Tracing and Evaluating a LangChain Agent | <ul><li>LangChain</li><li>OpenAI</li><li>agents</li><li>function calling</li></ul> | [![Open in Colab](https://img.shields.io/static/v1?message=Open%20in%20Colab\&logo=googlecolab\&labelColor=grey\&color=blue\&logoColor=orange\&label=%20)](https://colab.research.google.com/github/Arize-ai/phoenix/blob/main/tutorials/tracing/langchain\_agent\_tracing\_tutorial.ipynb) [![Open in GitHub](https://img.shields.io/static/v1?message=Open%20in%20GitHub\&logo=github\&labelColor=grey\&color=blue\&logoColor=white\&label=%20)](https://github.com/Arize-ai/phoenix/blob/main/tutorials/tracing/langchain\_agent\_tracing\_tutorial.ipynb) |
| Tracing and Evaluation a DSPy Application | <ul><li>LangChain</li><li>Google PaLM</li><li>retrieval-augmented generation</li></ul> | [![Open in Colab](https://img.shields.io/static/v1?message=Open%20in%20Colab\&logo=googlecolab\&labelColor=grey\&color=blue\&logoColor=orange\&label=%20)](https://colab.research.google.com/github/Arize-ai/phoenix/blob/main/tutorials/tracing/dspy\_tracing\_tutorial.ipynb) [![Open in GitHub](https://img.shields.io/static/v1?message=Open%20in%20GitHub\&logo=github\&labelColor=grey\&color=blue\&logoColor=white\&label=%20)](https://github.com/Arize-ai/phoenix/blob/main/tutorials/tracing/dspy\_tracing\_tutorial.ipynb) |

## Datasets and Experiments
Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ docker pull arizephoenix/phoenix:latest
{% tab title="app.phoenix.arize.com" %}
If you don't want to host an instance of Phoenix yourself or use a notebook instance, you can use a persistent instance provided on our site. Sign up for an Arize Phoenix account at [https://app.phoenix.arize.com/login](https://app.phoenix.arize.com/login)

For more details, see [hosted-phoenix.md](hosted-phoenix.md "mention")
For more details, see [hosted-phoenix.md](deployment/hosted-phoenix.md "mention")
{% endtab %}
{% endtabs %}

Expand Down
2 changes: 1 addition & 1 deletion docs/setup/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: How to get started with Phoenix

Phoenix is designed to be extremely portable and can run as a container or in a notebook.

* [Hosted Phoenix Sandboxes by Arize](../hosted-phoenix.md)
* [Hosted Phoenix Sandboxes by Arize](../deployment/hosted-phoenix.md)
* [In a python notebook](../environments.md#notebooks)
* [From the command line](../environments.md#terminal)
* [In a Container](../environments.md#container)
Expand Down

0 comments on commit 62798ad

Please sign in to comment.