Skip to content

voxel51/fiftyone-brain

Repository files navigation


FiftyOne Brain contains the open source AI/ML capabilities for the FiftyOne ecosystem, enabling users to automatically analyze and manipulate their datasets and models. FiftyOne Brain includes features like visual similarity search, query by text, finding unique and representative samples, finding media quality problems and annotation mistakes, and more 🚀

Documentation

Public documentation for the FiftyOne Brain is available here.

Installation

The FiftyOne Brain is distributed via the fiftyone-brain package, and a suitable version is automatically included with every fiftyone install:

pip install fiftyone
pip show fiftyone-brain

Installing from source

If you wish to do a source install of the latest FiftyOne Brain version, simply clone this repository:

git clone https://github.com/voxel51/fiftyone-brain
cd fiftyone-brain

and run the install script:

# Mac or Linux
bash install.bash

# Windows
.\install.bat

Developer installation

If you are a developer contributing to this repository, you should perform a developer installation using the -d flag of the install script:

# Mac or Linux
bash install.bash -d

# Windows
.\install.bat -d

Check out the contribution guide to get started.

Uninstallation

pip uninstall fiftyone-brain

Repository layout

  • fiftyone/brain/ definition of the fiftyone.brain namespace
  • requirements/ Python requirements for the project
  • tests/ tests for the various components of the Brain

Citation

If you use the FiftyOne Brain in your research, please cite the project:

@article{moore2020fiftyone,
  title={FiftyOne},
  author={Moore, B. E. and Corso, J. J.},
  journal={GitHub. Note: https://github.com/voxel51/fiftyone-brain},
  year={2020}
}