Skip to content
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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ pip install embedding-atlas
embedding-atlas <your-dataset.parquet>
```

In addition to the command line tool, Embedding Atlas is also available as a Jupyter widget:
In addition to the command line tool, Embedding Atlas is also available as a Python Notebook (e.g., Jupyter) widget:

```python
from embedding_atlas.widget import EmbeddingAtlasWidget
Expand Down
2 changes: 1 addition & 1 deletion packages/backend/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Embedding Atlas

A Python package that provides a command line tool to visualize a dataset with embeddings. It also includes a Jupyter widget and a Streamlit widget.
A Python package that provides a command line tool to visualize a dataset with embeddings. It also includes a Python Notebook (e.g., Jupyter) widget and a Streamlit widget.

- Documentation: https://apple.github.io/embedding-atlas
- GitHub: https://github.com/apple/embedding-atlas
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ export default defineConfig({
text: "Use Embedding Atlas",
items: [
{ text: "Command Line Utility", link: "/tool" },
{ text: "Jupyter Widget", link: "/widget" },
{ text: "Python Notebook Widget", link: "/widget" },
{ text: "Streamlit Component", link: "/streamlit" },
],
},
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Embedding Atlas is released as two packages:

- A Python package `embedding-atlas` that provides:
- A [command line utility](./tool.md) for running Embedding Atlas on a data frame.
- A [Jupyter widget](./widget.md) for using Embedding Atlas in Jupyter notebooks.
- A [Python Notebook widget](./widget.md) for using Embedding Atlas in interactive Python notebooks.
- A [Streamlit component](./streamlit.md) for using Embedding Atlas in Streamlit apps.

All of these approaches allow you to compute embeddings (with custom models) and projections.
Expand Down
6 changes: 3 additions & 3 deletions packages/docs/widget.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Jupyter Widget
# Python Notebook Widget

The Python package also provides a Jupyter widget to use Embedding Atlas in your notebooks.
The Python package also provides a Python notebook widget to use Embedding Atlas in your notebooks. The widget uses [AnyWidget](https://anywidget.dev) and supports Jupyter, Marimo, Colab, VSCode, and more.

## Installation

Expand Down Expand Up @@ -49,4 +49,4 @@ from embedding_atlas.widget import EmbeddingAtlasWidget

Below are the constructor options of the widget:

<!-- @doc(python-docstring): embedding_atlas.widget:EmbeddingAtlasWidget.__init__ -->
<!-- @doc(python-docstring): embedding_atlas.widget:EmbeddingAtlasWidget.__init__ -->