| Name | fiftyone JSON |
| Version |
1.7.2
JSON |
| download |
| home_page | https://github.com/voxel51/fiftyone |
| Summary | FiftyOne: the open-source tool for building high-quality datasets and computer vision models |
| upload_time | 2025-08-05 17:43:25 |
| maintainer | None |
| docs_url | None |
| author | Voxel51, Inc. |
| requires_python | >=3.9 |
| license | Apache |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<div align="center">
<p align="center">
<!-- prettier-ignore -->
<img src="https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png" height="55px">
<img src="https://user-images.githubusercontent.com/25985824/106288518-24bb7680-6216-11eb-8f10-60052c519586.png" height="50px">
**The open-source tool for building high-quality datasets and computer vision
models**
---
<!-- prettier-ignore -->
<a href="https://voxel51.com/fiftyone">Website</a> •
<a href="https://voxel51.com/docs/fiftyone">Docs</a> •
<a href="https://colab.research.google.com/github/voxel51/fiftyone-examples/blob/master/examples/quickstart.ipynb">Try it Now</a> •
<a href="https://voxel51.com/docs/fiftyone/tutorials/index.html">Tutorials</a> •
<a href="https://github.com/voxel51/fiftyone-examples">Examples</a> •
<a href="https://voxel51.com/blog/">Blog</a> •
<a href="https://discord.gg/fiftyone-community">Community</a>
[](https://pypi.org/project/fiftyone)
[](https://pypi.org/project/fiftyone)
[](https://pepy.tech/project/fiftyone)
[](https://hub.docker.com/r/voxel51/fiftyone/)
[](LICENSE)
[](https://discord.gg/fiftyone-community)
[](https://medium.com/voxel51)
[](https://share.hsforms.com/1zpJ60ggaQtOoVeBqIZdaaA2ykyk)
[](https://twitter.com/voxel51)
</p>
</div>
# 👋 hey there!
We created **[FiftyOne](https://fiftyone.ai)** to supercharge your visual AI
projects by enabling you to visualize datasets, analyze models, and improve
data quality more efficiently than ever before 🤝
If you're looking to scale to production-grade, collaborative, cloud-native
enterprise workloads, check out
**[FiftyOne Enterprise](http://voxel51.com/enterprise)** 🚀
<div id='installation'/>
## <img src="https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png" height="20px"> installation 💻
As simple as:
```shell
pip install fiftyone
```
<details>
<summary>More details</summary>
### Installation options
FiftyOne supports Python 3.9 - 3.11.
For most users, we recommend installing the latest release version of FiftyOne
via `pip` as shown above.
If you want to contribute to FiftyOne or install the latest development
version, then you can also perform a [source install](#source-install).
See the [prerequisites section](#prerequisites) for system-specific setup
information.
We strongly recommend that you install FiftyOne in a
[virtual environment](https://voxel51.com/docs/fiftyone/getting_started/virtualenv.html)
to maintain a clean workspace.
Consult the
[installation guide](https://voxel51.com/docs/fiftyone/getting_started/install.html)
for troubleshooting and other information about getting up-and-running with
FiftyOne.
</details>
<div id='source-install'/>
<details>
<summary>Install from source</summary>
### Source installations
Follow the instructions below to install FiftyOne from source and build the
App.
You'll need the following tools installed:
- [Python](https://www.python.org) (3.9 - 3.11)
- [Node.js](https://nodejs.org) - on Linux, we recommend using
[nvm](https://github.com/nvm-sh/nvm) to install an up-to-date version.
- [Yarn](https://yarnpkg.com) - once Node.js is installed, you can
[enable Yarn](https://yarnpkg.com/getting-started/install) via
`corepack enable`
We strongly recommend that you install FiftyOne in a
[virtual environment](https://voxel51.com/docs/fiftyone/getting_started/virtualenv.html)
to maintain a clean workspace.
If you are working in Google Colab,
[skip to here](#source-installs-in-google-colab).
First, clone the repository:
```shell
git clone https://github.com/voxel51/fiftyone
cd fiftyone
```
Then run the install script:
```shell
# Mac or Linux
bash install.bash
# Windows
.\install.bat
```
If you run into issues importing FiftyOne, you may need to add the path to the
cloned repository to your `PYTHONPATH`:
```shell
export PYTHONPATH=$PYTHONPATH:/path/to/fiftyone
```
Note that the install script adds to your `nvm` settings in your `~/.bashrc` or
`~/.bash_profile`, which is needed for installing and building the App.
### Upgrading your source installation
To upgrade an existing source installation to the bleeding edge, simply pull
the latest `develop` branch and rerun the install script:
```shell
git checkout develop
git pull
# Mac or Linux
bash install.bash
# Windows
.\install.bat
```
### Rebuilding the App
When you pull in new changes to the App, you will need to rebuild it, which you
can do either by rerunning the install script or just running `yarn build` in
the `./app` directory.
### Developer installation
If you would like to
[contribute to FiftyOne](https://github.com/voxel51/fiftyone/blob/develop/CONTRIBUTING.md),
you should perform a developer installation using the `-d` flag of the install
script:
```shell
# Mac or Linux
bash install.bash -d
# Windows
.\install.bat -d
```
Although not required, developers typically prefer to configure their FiftyOne
installation to connect to a self-installed and managed instance of MongoDB,
which you can do by following
[these simple steps](https://docs.voxel51.com/user_guide/config.html#configuring-a-mongodb-connection).
### Source installs in Google Colab
You can install from source in
[Google Colab](https://colab.research.google.com) by running the following in a
cell and then **restarting the runtime**:
```shell
%%shell
git clone --depth 1 https://github.com/voxel51/fiftyone.git
cd fiftyone
# Mac or Linux
bash install.bash
# Windows
.\install.bat
```
### Generating documentation
See the
[docs guide](https://github.com/voxel51/fiftyone/blob/develop/docs/README.md)
for information on building and contributing to the documentation.
### Uninstallation
You can uninstall FiftyOne as follows:
```shell
pip uninstall fiftyone fiftyone-brain fiftyone-db
```
</details>
<div id='prerequisites'/>
<details>
<summary>Prerequisites for beginners</summary>
### System-specific setup
Follow the instructions for your operating system or environment to perform
basic system setup before [installing FiftyOne](#installation).
If you're an experienced developer, you've likely already done this.
<details>
<summary>Linux</summary>
<div id='prerequisites-linux'/>
#### 1. Install Python and other dependencies
These steps work on a clean install of Ubuntu Desktop 24.04, and should also
work on Ubuntu 24.04 and 22.04, and on Ubuntu Server:
```shell
sudo apt-get update
sudo apt-get upgrade
sudo apt-get install python3-venv python3-dev build-essential git-all libgl1-mesa-dev
```
- On Linux, you will need at least the `openssl` and `libcurl` packages
- On Debian-based distributions, you will need to install `libcurl4` or
`libcurl3` instead of `libcurl`, depending on the age of your distribution
```shell
# Ubuntu
sudo apt install libcurl4 openssl
# Fedora
sudo dnf install libcurl openssl
```
#### 2. Create and activate a virtual environment
```shell
python3 -m venv fiftyone_env
source fiftyone_env/bin/activate
```
#### 3. Install FFmpeg (optional)
If you plan to work with video datasets, you'll need to install
[FFmpeg](https://ffmpeg.org):
```shell
sudo apt-get install ffmpeg
```
</details>
<details>
<summary>MacOS</summary>
<div id='prerequisites-macos'/>
#### 1. Install Xcode Command Line Tools
```shell
xcode-select --install
```
#### 2. Install Homebrew
```shell
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```
After running the above command, follow the instructions in your terminal to
complete the Homebrew installation.
#### 3. Install Python
```shell
brew install python@3.9
brew install protobuf
```
#### 4. Create and activate a virtual environment
```shell
python3 -m venv fiftyone_env
source fiftyone_env/bin/activate
```
#### 5. Install FFmpeg (optional)
If you plan to work with video datasets, you'll need to install
[FFmpeg](https://ffmpeg.org):
```shell
brew install ffmpeg
```
</details>
<details>
<summary>Windows</summary>
<div id='prerequisites-windows'/>
#### 1. Install Python
⚠️ The version of Python that is available in the Microsoft Store is **not
recommended** ⚠️
Download a Python 3.9 - 3.11 installer from
[python.org](https://www.python.org/downloads/). Make sure to pick a 64-bit
version. For example, this
[Python 3.10.11 installer](https://www.python.org/ftp/python/3.10.11/python-3.10.11-amd64.exe).
Double-click on the installer to run it, and follow the steps in the installer.
- Check the box to add Python to your `PATH`
- At the end of the installer, there is an option to disable the `PATH`
length limit. It is recommended to click this
#### 2. Install Microsoft Visual C++
Download
[Microsoft Visual C++ Redistributable](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist).
Double-click on the installer to run it, and follow the steps in the installer.
#### 3. Install Git
Download Git from [this link](https://git-scm.com/download/win). Double-click
on the installer to run it, and follow the steps in the installer.
#### 4. Create and activate a virtual environment
- Press `Win + R`. type `cmd`, and press `Enter`. Alternatively, search
**Command Prompt** in the Start Menu.
- Navigate to your project. `cd C:\path\to\your\project`
- Create the environment `python -m venv fiftyone_env`
- Activate the environment typing this in the command line window
`fiftyone_env\Scripts\activate`
- After activation, your command prompt should change and show the name of
the virtual environment `(fiftyon_env) C:\path\to\your\project`
#### 5. Install FFmpeg (optional)
If you plan to work with video datasets, you'll need to install
[FFmpeg](https://ffmpeg.org).
Download an FFmpeg binary from [here](https://ffmpeg.org/download.html). Add
FFmpeg's path (e.g., `C:\ffmpeg\bin`) to your `PATH` environmental variable.
</details>
<details>
<summary>Docker</summary>
<div id='prerequisites-docker'/>
<br>
Refer to
[these instructions](https://voxel51.com/docs/fiftyone/environments/index.html#docker)
to see how to build and run Docker images containing release or source builds
of FiftyOne.
</details>
</details>
<div id='quickstart'>
## <img src="https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png" height="20px"> quickstart 🚀
Dive right into FiftyOne by opening a Python shell and running the snippet
below, which downloads a
[small dataset](https://voxel51.com/docs/fiftyone/user_guide/dataset_zoo/datasets.html#quickstart)
and launches the
[FiftyOne App](https://voxel51.com/docs/fiftyone/user_guide/app.html) so you
can explore it:
```py
import fiftyone as fo
import fiftyone.zoo as foz
dataset = foz.load_zoo_dataset("quickstart")
session = fo.launch_app(dataset)
```
Then check out
[this Colab notebook](https://colab.research.google.com/github/voxel51/fiftyone-examples/blob/master/examples/quickstart.ipynb)
to see some common workflows on the quickstart dataset.
Note that if you are running the above code in a script, you must include
`session.wait()` to block execution until you close the App. See
[this page](https://voxel51.com/docs/fiftyone/user_guide/app.html#creating-a-session)
for more information.
<div id='key-features'>
## <img src="https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png" height="20px"> key features 🔑
- **[Visualize Complex Datasets:](https://docs.voxel51.com/user_guide/app.html)**
Easily explore images, videos, and associated labels in a powerful visual
interface.
https://github.com/user-attachments/assets/9dc2db88-967d-43fa-bda0-85e4d5ab6a7a
- **[Explore Embeddings:](https://docs.voxel51.com/user_guide/app.html#embeddings-panel)**
Select points of interest and view the corresponding samples/labels.
https://github.com/user-attachments/assets/246faeb7-dcab-4e01-9357-e50f6b106da7
- **[Analyze and Improve Models:](https://docs.voxel51.com/user_guide/evaluation.html)**
Evaluate model performance, identify failure modes, and fine-tune your
models.
https://github.com/user-attachments/assets/8c32d6c4-51e7-4fea-9a3c-2ffd9690f5d6
- **[Advanced Data Curation:](https://docs.voxel51.com/brain.html)** Quickly
find and fix data issues, annotation errors, and edge cases.
https://github.com/user-attachments/assets/24fa1960-c2dd-46ae-ae5f-d58b3b84cfe4
- **[Rich Integrations:](https://docs.voxel51.com/integrations/index.html)**
Works with popular deep learning libraries like PyTorch, Hugging Face,
Ultralytics, and more.
https://github.com/user-attachments/assets/de5f25e1-a967-4362-9e04-616449e745e5
- **[Open and Extensible:](https://docs.voxel51.com/plugins/index.html)**
Customize and extend FiftyOne to fit your specific needs.
https://github.com/user-attachments/assets/c7ed496d-0cf7-45d6-9853-e349f1abd6f8
<div id='additional-resources'>
## <img src="https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png" height="20px"> additional resources 🚁
| [FiftyOne Enterprise](https://voxel51.com/enterprise) | [VoxelGPT](https://github.com/voxel51/voxelgpt) | [Plugins](https://voxel51.com/plugins) | [Vector Search](https://voxel51.com/blog/the-computer-vision-interface-for-vector-search) | [Dataset Zoo](https://docs.voxel51.com/dataset_zoo/index.html) | [Model Zoo](https://docs.voxel51.com/model_zoo/index.html) | [FiftyOne Brain](https://docs.voxel51.com/brain.html) |
| ----------------------------------------------------- | ----------------------------------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------- | -------------------------------------------------------------- | ---------------------------------------------------------- | ----------------------------------------------------- |
</div>
<div id='documentation'/>
## <img src="https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png" height="20px"> documentation 🪪
Full documentation for FiftyOne is available at
[fiftyone.ai](https://fiftyone.ai).
| [Tutorials](https://voxel51.com/docs/fiftyone/tutorials/index.html) | [Recipes](https://voxel51.com/docs/fiftyone/recipes/index.html) | [Examples](https://github.com/voxel51/fiftyone-examples) | [User Guide](https://voxel51.com/docs/fiftyone/user_guide/index.html) | [CLI Documentation](https://voxel51.com/docs/fiftyone/cli/index.html) | [API Reference](https://voxel51.com/docs/fiftyone/api/fiftyone.html) |
| ------------------------------------------------------------------- | --------------------------------------------------------------- | -------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | -------------------------------------------------------------------- |
</div>
<div id='fiftyone-teams'/>
## <img src="https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png" height="20px"> FiftyOne Enterprise 🏎️
Want to securely collaborate on billions of samples in the cloud and connect to
your compute resources to automate your workflows? Check out
[FiftyOne Enterprise](https://voxel51.com/enterprise).
<div id='faq'/>
## <img src="https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png" height="20px"> faq & troubleshooting ⛓️💥
Refer to our
[common issues](https://docs.voxel51.com/getting_started/troubleshooting.html)
page to troubleshoot installation issues. If you're still stuck, check our
[frequently asked questions](https://docs.voxel51.com/faq/index.html) page for
more answers.
If you encounter an issue that the above resources don't help you resolve, feel
free to [open an issue on GitHub](https://github.com/voxel51/fiftyone/issues)
or contact us on [Discord](https://discord.gg/fiftyone-community).
</div>
<div id='community'/>
## <img src="https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png" height="20px"> join our community 🤝
Connect with us through your preferred channels:
[](https://discord.gg/fiftyone-community)
[](https://medium.com/voxel51)
[](https://twitter.com/voxel51)
[](https://www.linkedin.com/company/voxel51)
[](https://www.facebook.com/voxel51)
🎊 **Share how FiftyOne makes your visual AI projects a reality on social media
and tag us with @Voxel51 and #FiftyOne** 🎊
</div>
<div id='contributors'/>
## <img src="https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png" height="20px"> contributors 🧡
FiftyOne and [FiftyOne Brain](https://github.com/voxel51/fiftyone-brain) are
open source and community contributions are welcome! Check out the
[contribution guide](https://github.com/voxel51/fiftyone/blob/develop/CONTRIBUTING.md)
to learn how to get involved.
Special thanks to these amazing people for contributing to FiftyOne!
<a href="https://github.com/voxel51/fiftyone/graphs/contributors">
<img src="https://contrib.rocks/image?repo=voxel51/fiftyone" />
</a>
<div id='citation'/>
## <img src="https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png" height="20px"> citation 📖
If you use FiftyOne in your research, feel free to cite the project (but only
if you love it 😊):
```bibtex
@article{moore2020fiftyone,
title={FiftyOne},
author={Moore, B. E. and Corso, J. J.},
journal={GitHub. Note: https://github.com/voxel51/fiftyone},
year={2020}
}
```
Raw data
{
"_id": null,
"home_page": "https://github.com/voxel51/fiftyone",
"name": "fiftyone",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Voxel51, Inc.",
"author_email": "info@voxel51.com",
"download_url": "https://files.pythonhosted.org/packages/ff/e8/b97eda961ff53e438d9b27a661543a26932644b86306bd7f2be14e95f09c/fiftyone-1.7.2.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n<p align=\"center\">\n\n<!-- prettier-ignore -->\n<img src=\"https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png\" height=\"55px\"> \n<img src=\"https://user-images.githubusercontent.com/25985824/106288518-24bb7680-6216-11eb-8f10-60052c519586.png\" height=\"50px\">\n\n**The open-source tool for building high-quality datasets and computer vision\nmodels**\n\n---\n\n<!-- prettier-ignore -->\n<a href=\"https://voxel51.com/fiftyone\">Website</a> \u2022\n<a href=\"https://voxel51.com/docs/fiftyone\">Docs</a> \u2022\n<a href=\"https://colab.research.google.com/github/voxel51/fiftyone-examples/blob/master/examples/quickstart.ipynb\">Try it Now</a> \u2022\n<a href=\"https://voxel51.com/docs/fiftyone/tutorials/index.html\">Tutorials</a> \u2022\n<a href=\"https://github.com/voxel51/fiftyone-examples\">Examples</a> \u2022\n<a href=\"https://voxel51.com/blog/\">Blog</a> \u2022\n<a href=\"https://discord.gg/fiftyone-community\">Community</a>\n\n[](https://pypi.org/project/fiftyone)\n[](https://pypi.org/project/fiftyone)\n[](https://pepy.tech/project/fiftyone)\n[](https://hub.docker.com/r/voxel51/fiftyone/)\n[](LICENSE)\n[](https://discord.gg/fiftyone-community)\n[](https://medium.com/voxel51)\n[](https://share.hsforms.com/1zpJ60ggaQtOoVeBqIZdaaA2ykyk)\n[](https://twitter.com/voxel51)\n\n</p>\n</div>\n\n# \ud83d\udc4b hey there!\n\nWe created **[FiftyOne](https://fiftyone.ai)** to supercharge your visual AI\nprojects by enabling you to visualize datasets, analyze models, and improve\ndata quality more efficiently than ever before \ud83e\udd1d\n\nIf you're looking to scale to production-grade, collaborative, cloud-native\nenterprise workloads, check out\n**[FiftyOne Enterprise](http://voxel51.com/enterprise)** \ud83d\ude80\n\n\n<div id='installation'/>\n\n## <img src=\"https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png\" height=\"20px\"> installation \ud83d\udcbb\n\nAs simple as:\n\n```shell\npip install fiftyone\n```\n\n<details>\n<summary>More details</summary>\n\n### Installation options\n\nFiftyOne supports Python 3.9 - 3.11.\n\nFor most users, we recommend installing the latest release version of FiftyOne\nvia `pip` as shown above.\n\nIf you want to contribute to FiftyOne or install the latest development\nversion, then you can also perform a [source install](#source-install).\n\nSee the [prerequisites section](#prerequisites) for system-specific setup\ninformation.\n\nWe strongly recommend that you install FiftyOne in a\n[virtual environment](https://voxel51.com/docs/fiftyone/getting_started/virtualenv.html)\nto maintain a clean workspace.\n\nConsult the\n[installation guide](https://voxel51.com/docs/fiftyone/getting_started/install.html)\nfor troubleshooting and other information about getting up-and-running with\nFiftyOne.\n\n</details>\n\n<div id='source-install'/>\n\n<details>\n<summary>Install from source</summary>\n\n### Source installations\n\nFollow the instructions below to install FiftyOne from source and build the\nApp.\n\nYou'll need the following tools installed:\n\n- [Python](https://www.python.org) (3.9 - 3.11)\n- [Node.js](https://nodejs.org) - on Linux, we recommend using\n [nvm](https://github.com/nvm-sh/nvm) to install an up-to-date version.\n- [Yarn](https://yarnpkg.com) - once Node.js is installed, you can\n [enable Yarn](https://yarnpkg.com/getting-started/install) via\n `corepack enable`\n\nWe strongly recommend that you install FiftyOne in a\n[virtual environment](https://voxel51.com/docs/fiftyone/getting_started/virtualenv.html)\nto maintain a clean workspace.\n\nIf you are working in Google Colab,\n[skip to here](#source-installs-in-google-colab).\n\nFirst, clone the repository:\n\n```shell\ngit clone https://github.com/voxel51/fiftyone\ncd fiftyone\n```\n\nThen run the install script:\n\n```shell\n# Mac or Linux\nbash install.bash\n\n# Windows\n.\\install.bat\n```\n\nIf you run into issues importing FiftyOne, you may need to add the path to the\ncloned repository to your `PYTHONPATH`:\n\n```shell\nexport PYTHONPATH=$PYTHONPATH:/path/to/fiftyone\n```\n\nNote that the install script adds to your `nvm` settings in your `~/.bashrc` or\n`~/.bash_profile`, which is needed for installing and building the App.\n\n### Upgrading your source installation\n\nTo upgrade an existing source installation to the bleeding edge, simply pull\nthe latest `develop` branch and rerun the install script:\n\n```shell\ngit checkout develop\ngit pull\n\n# Mac or Linux\nbash install.bash\n\n# Windows\n.\\install.bat\n```\n\n### Rebuilding the App\n\nWhen you pull in new changes to the App, you will need to rebuild it, which you\ncan do either by rerunning the install script or just running `yarn build` in\nthe `./app` directory.\n\n### Developer installation\n\nIf you would like to\n[contribute to FiftyOne](https://github.com/voxel51/fiftyone/blob/develop/CONTRIBUTING.md),\nyou should perform a developer installation using the `-d` flag of the install\nscript:\n\n```shell\n# Mac or Linux\nbash install.bash -d\n\n# Windows\n.\\install.bat -d\n```\n\nAlthough not required, developers typically prefer to configure their FiftyOne\ninstallation to connect to a self-installed and managed instance of MongoDB,\nwhich you can do by following\n[these simple steps](https://docs.voxel51.com/user_guide/config.html#configuring-a-mongodb-connection).\n\n### Source installs in Google Colab\n\nYou can install from source in\n[Google Colab](https://colab.research.google.com) by running the following in a\ncell and then **restarting the runtime**:\n\n```shell\n%%shell\n\ngit clone --depth 1 https://github.com/voxel51/fiftyone.git\ncd fiftyone\n\n# Mac or Linux\nbash install.bash\n\n# Windows\n.\\install.bat\n```\n\n### Generating documentation\n\nSee the\n[docs guide](https://github.com/voxel51/fiftyone/blob/develop/docs/README.md)\nfor information on building and contributing to the documentation.\n\n### Uninstallation\n\nYou can uninstall FiftyOne as follows:\n\n```shell\npip uninstall fiftyone fiftyone-brain fiftyone-db\n```\n\n</details>\n\n<div id='prerequisites'/>\n\n<details>\n<summary>Prerequisites for beginners</summary>\n\n### System-specific setup\n\nFollow the instructions for your operating system or environment to perform\nbasic system setup before [installing FiftyOne](#installation).\n\nIf you're an experienced developer, you've likely already done this.\n\n<details>\n<summary>Linux</summary>\n\n<div id='prerequisites-linux'/>\n\n#### 1. Install Python and other dependencies\n\nThese steps work on a clean install of Ubuntu Desktop 24.04, and should also\nwork on Ubuntu 24.04 and 22.04, and on Ubuntu Server:\n\n```shell\nsudo apt-get update\nsudo apt-get upgrade\nsudo apt-get install python3-venv python3-dev build-essential git-all libgl1-mesa-dev\n```\n\n- On Linux, you will need at least the `openssl` and `libcurl` packages\n- On Debian-based distributions, you will need to install `libcurl4` or\n `libcurl3` instead of `libcurl`, depending on the age of your distribution\n\n```shell\n# Ubuntu\nsudo apt install libcurl4 openssl\n\n# Fedora\nsudo dnf install libcurl openssl\n```\n\n#### 2. Create and activate a virtual environment\n\n```shell\npython3 -m venv fiftyone_env\nsource fiftyone_env/bin/activate\n```\n\n#### 3. Install FFmpeg (optional)\n\nIf you plan to work with video datasets, you'll need to install\n[FFmpeg](https://ffmpeg.org):\n\n```shell\nsudo apt-get install ffmpeg\n```\n\n</details>\n\n<details>\n<summary>MacOS</summary>\n\n<div id='prerequisites-macos'/>\n\n#### 1. Install Xcode Command Line Tools\n\n```shell\nxcode-select --install\n```\n\n#### 2. Install Homebrew\n\n```shell\n/bin/bash -c \"$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)\"\n```\n\nAfter running the above command, follow the instructions in your terminal to\ncomplete the Homebrew installation.\n\n#### 3. Install Python\n\n```shell\nbrew install python@3.9\nbrew install protobuf\n```\n\n#### 4. Create and activate a virtual environment\n\n```shell\npython3 -m venv fiftyone_env\nsource fiftyone_env/bin/activate\n```\n\n#### 5. Install FFmpeg (optional)\n\nIf you plan to work with video datasets, you'll need to install\n[FFmpeg](https://ffmpeg.org):\n\n```shell\nbrew install ffmpeg\n```\n\n</details>\n\n<details>\n<summary>Windows</summary>\n\n<div id='prerequisites-windows'/>\n\n#### 1. Install Python\n\n\u26a0\ufe0f The version of Python that is available in the Microsoft Store is **not\nrecommended** \u26a0\ufe0f\n\nDownload a Python 3.9 - 3.11 installer from\n[python.org](https://www.python.org/downloads/). Make sure to pick a 64-bit\nversion. For example, this\n[Python 3.10.11 installer](https://www.python.org/ftp/python/3.10.11/python-3.10.11-amd64.exe).\n\nDouble-click on the installer to run it, and follow the steps in the installer.\n\n- Check the box to add Python to your `PATH`\n- At the end of the installer, there is an option to disable the `PATH`\n length limit. It is recommended to click this\n\n#### 2. Install Microsoft Visual C++\n\nDownload\n[Microsoft Visual C++ Redistributable](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist).\nDouble-click on the installer to run it, and follow the steps in the installer.\n\n#### 3. Install Git\n\nDownload Git from [this link](https://git-scm.com/download/win). Double-click\non the installer to run it, and follow the steps in the installer.\n\n#### 4. Create and activate a virtual environment\n\n- Press `Win + R`. type `cmd`, and press `Enter`. Alternatively, search\n **Command Prompt** in the Start Menu.\n- Navigate to your project. `cd C:\\path\\to\\your\\project`\n- Create the environment `python -m venv fiftyone_env`\n- Activate the environment typing this in the command line window\n `fiftyone_env\\Scripts\\activate`\n- After activation, your command prompt should change and show the name of\n the virtual environment `(fiftyon_env) C:\\path\\to\\your\\project`\n\n#### 5. Install FFmpeg (optional)\n\nIf you plan to work with video datasets, you'll need to install\n[FFmpeg](https://ffmpeg.org).\n\nDownload an FFmpeg binary from [here](https://ffmpeg.org/download.html). Add\nFFmpeg's path (e.g., `C:\\ffmpeg\\bin`) to your `PATH` environmental variable.\n\n</details>\n\n<details>\n<summary>Docker</summary>\n\n<div id='prerequisites-docker'/>\n<br>\n\nRefer to\n[these instructions](https://voxel51.com/docs/fiftyone/environments/index.html#docker)\nto see how to build and run Docker images containing release or source builds\nof FiftyOne.\n\n</details>\n\n</details>\n\n<div id='quickstart'>\n\n## <img src=\"https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png\" height=\"20px\"> quickstart \ud83d\ude80\n\nDive right into FiftyOne by opening a Python shell and running the snippet\nbelow, which downloads a\n[small dataset](https://voxel51.com/docs/fiftyone/user_guide/dataset_zoo/datasets.html#quickstart)\nand launches the\n[FiftyOne App](https://voxel51.com/docs/fiftyone/user_guide/app.html) so you\ncan explore it:\n\n```py\nimport fiftyone as fo\nimport fiftyone.zoo as foz\n\ndataset = foz.load_zoo_dataset(\"quickstart\")\nsession = fo.launch_app(dataset)\n```\n\nThen check out\n[this Colab notebook](https://colab.research.google.com/github/voxel51/fiftyone-examples/blob/master/examples/quickstart.ipynb)\nto see some common workflows on the quickstart dataset.\n\nNote that if you are running the above code in a script, you must include\n`session.wait()` to block execution until you close the App. See\n[this page](https://voxel51.com/docs/fiftyone/user_guide/app.html#creating-a-session)\nfor more information.\n\n\n<div id='key-features'>\n\n## <img src=\"https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png\" height=\"20px\"> key features \ud83d\udd11\n\n- **[Visualize Complex Datasets:](https://docs.voxel51.com/user_guide/app.html)**\n Easily explore images, videos, and associated labels in a powerful visual\n interface.\n\nhttps://github.com/user-attachments/assets/9dc2db88-967d-43fa-bda0-85e4d5ab6a7a\n\n- **[Explore Embeddings:](https://docs.voxel51.com/user_guide/app.html#embeddings-panel)**\n Select points of interest and view the corresponding samples/labels.\n\nhttps://github.com/user-attachments/assets/246faeb7-dcab-4e01-9357-e50f6b106da7\n\n- **[Analyze and Improve Models:](https://docs.voxel51.com/user_guide/evaluation.html)**\n Evaluate model performance, identify failure modes, and fine-tune your\n models.\n\nhttps://github.com/user-attachments/assets/8c32d6c4-51e7-4fea-9a3c-2ffd9690f5d6\n\n- **[Advanced Data Curation:](https://docs.voxel51.com/brain.html)** Quickly\n find and fix data issues, annotation errors, and edge cases.\n\nhttps://github.com/user-attachments/assets/24fa1960-c2dd-46ae-ae5f-d58b3b84cfe4\n\n- **[Rich Integrations:](https://docs.voxel51.com/integrations/index.html)**\n Works with popular deep learning libraries like PyTorch, Hugging Face,\n Ultralytics, and more.\n\nhttps://github.com/user-attachments/assets/de5f25e1-a967-4362-9e04-616449e745e5\n\n- **[Open and Extensible:](https://docs.voxel51.com/plugins/index.html)**\n Customize and extend FiftyOne to fit your specific needs.\n\nhttps://github.com/user-attachments/assets/c7ed496d-0cf7-45d6-9853-e349f1abd6f8\n\n<div id='additional-resources'>\n\n## <img src=\"https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png\" height=\"20px\"> additional resources \ud83d\ude81\n\n| [FiftyOne Enterprise](https://voxel51.com/enterprise) | [VoxelGPT](https://github.com/voxel51/voxelgpt) | [Plugins](https://voxel51.com/plugins) | [Vector Search](https://voxel51.com/blog/the-computer-vision-interface-for-vector-search) | [Dataset Zoo](https://docs.voxel51.com/dataset_zoo/index.html) | [Model Zoo](https://docs.voxel51.com/model_zoo/index.html) | [FiftyOne Brain](https://docs.voxel51.com/brain.html) |\n| ----------------------------------------------------- | ----------------------------------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------- | -------------------------------------------------------------- | ---------------------------------------------------------- | ----------------------------------------------------- |\n\n</div>\n\n<div id='documentation'/>\n\n## <img src=\"https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png\" height=\"20px\"> documentation \ud83e\udeaa\n\nFull documentation for FiftyOne is available at\n[fiftyone.ai](https://fiftyone.ai).\n\n| [Tutorials](https://voxel51.com/docs/fiftyone/tutorials/index.html) | [Recipes](https://voxel51.com/docs/fiftyone/recipes/index.html) | [Examples](https://github.com/voxel51/fiftyone-examples) | [User Guide](https://voxel51.com/docs/fiftyone/user_guide/index.html) | [CLI Documentation](https://voxel51.com/docs/fiftyone/cli/index.html) | [API Reference](https://voxel51.com/docs/fiftyone/api/fiftyone.html) |\n| ------------------------------------------------------------------- | --------------------------------------------------------------- | -------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | -------------------------------------------------------------------- |\n\n</div>\n\n<div id='fiftyone-teams'/>\n\n## <img src=\"https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png\" height=\"20px\"> FiftyOne Enterprise \ud83c\udfce\ufe0f\n\nWant to securely collaborate on billions of samples in the cloud and connect to\nyour compute resources to automate your workflows? Check out\n[FiftyOne Enterprise](https://voxel51.com/enterprise).\n\n\n<div id='faq'/>\n\n## <img src=\"https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png\" height=\"20px\"> faq & troubleshooting \u26d3\ufe0f\u200d\ud83d\udca5\n\nRefer to our\n[common issues](https://docs.voxel51.com/getting_started/troubleshooting.html)\npage to troubleshoot installation issues. If you're still stuck, check our\n[frequently asked questions](https://docs.voxel51.com/faq/index.html) page for\nmore answers.\n\nIf you encounter an issue that the above resources don't help you resolve, feel\nfree to [open an issue on GitHub](https://github.com/voxel51/fiftyone/issues)\nor contact us on [Discord](https://discord.gg/fiftyone-community).\n\n</div>\n\n<div id='community'/>\n\n## <img src=\"https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png\" height=\"20px\"> join our community \ud83e\udd1d\n\nConnect with us through your preferred channels:\n\n[](https://discord.gg/fiftyone-community)\n[](https://medium.com/voxel51)\n[](https://twitter.com/voxel51)\n[](https://www.linkedin.com/company/voxel51)\n[](https://www.facebook.com/voxel51)\n\n\ud83c\udf8a **Share how FiftyOne makes your visual AI projects a reality on social media\nand tag us with @Voxel51 and #FiftyOne** \ud83c\udf8a\n\n</div>\n\n<div id='contributors'/>\n\n## <img src=\"https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png\" height=\"20px\"> contributors \ud83e\udde1\n\nFiftyOne and [FiftyOne Brain](https://github.com/voxel51/fiftyone-brain) are\nopen source and community contributions are welcome! Check out the\n[contribution guide](https://github.com/voxel51/fiftyone/blob/develop/CONTRIBUTING.md)\nto learn how to get involved.\n\nSpecial thanks to these amazing people for contributing to FiftyOne!\n\n<a href=\"https://github.com/voxel51/fiftyone/graphs/contributors\">\n <img src=\"https://contrib.rocks/image?repo=voxel51/fiftyone\" />\n</a>\n\n<div id='citation'/>\n\n## <img src=\"https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png\" height=\"20px\"> citation \ud83d\udcd6\n\nIf you use FiftyOne in your research, feel free to cite the project (but only\nif you love it \ud83d\ude0a):\n\n```bibtex\n@article{moore2020fiftyone,\n title={FiftyOne},\n author={Moore, B. E. and Corso, J. J.},\n journal={GitHub. Note: https://github.com/voxel51/fiftyone},\n year={2020}\n}\n```\n",
"bugtrack_url": null,
"license": "Apache",
"summary": "FiftyOne: the open-source tool for building high-quality datasets and computer vision models",
"version": "1.7.2",
"project_urls": {
"Homepage": "https://github.com/voxel51/fiftyone"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "6514e7c52aaabb00509dd0c354c5be059ad1bc0cde9975e52cd0f41c5fbec8fe",
"md5": "b83b8af7ca38eae9727d5e26cd938ff9",
"sha256": "145b54747ef9a7c89ff6696e4540cec4f9bdc5a43b5ec6226c30c7076fe36a4f"
},
"downloads": -1,
"filename": "fiftyone-1.7.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b83b8af7ca38eae9727d5e26cd938ff9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 10859544,
"upload_time": "2025-08-05T17:43:22",
"upload_time_iso_8601": "2025-08-05T17:43:22.988156Z",
"url": "https://files.pythonhosted.org/packages/65/14/e7c52aaabb00509dd0c354c5be059ad1bc0cde9975e52cd0f41c5fbec8fe/fiftyone-1.7.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ffe8b97eda961ff53e438d9b27a661543a26932644b86306bd7f2be14e95f09c",
"md5": "31be287797e8349333069457339529b3",
"sha256": "54c30672872f62fc508f2a8edde6d72a5af5d36e2e0613941d113a9aaa0d6dc6"
},
"downloads": -1,
"filename": "fiftyone-1.7.2.tar.gz",
"has_sig": false,
"md5_digest": "31be287797e8349333069457339529b3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 10726478,
"upload_time": "2025-08-05T17:43:25",
"upload_time_iso_8601": "2025-08-05T17:43:25.483000Z",
"url": "https://files.pythonhosted.org/packages/ff/e8/b97eda961ff53e438d9b27a661543a26932644b86306bd7f2be14e95f09c/fiftyone-1.7.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-05 17:43:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "voxel51",
"github_project": "fiftyone",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "fiftyone"
}
