FiftyOne Installation¶
Note
FiftyOne is rapidly growing. Sign up for the mailing list so we can keep you posted on new features as they come out!
Prerequisites¶
You will need a working Python installation. FiftyOne currently requires Python 3.6 - 3.9.
Although Python 3.9 is supported, note that some dependencies, notably
scikit-image
and scikit-learn
, will need to be built from source. Also
note that tensorflow
does not yet support 3.9.
On Linux, we recommended installing Python through your system package manager
(APT, YUM, etc.) if it is available. On other platforms, Python can be
downloaded from python.org. To verify that
a suitable Python version is installed and accessible, run python3 --version
or python --version
.
We encourage installing FiftyOne in a virtual environment. See setting up a virtual environment for more details.
Installing FiftyOne¶
To install FiftyOne, ensure you have activated any virtual environment that you are using, then run:
pip install fiftyone
This will install FiftyOne and all of its dependencies, which may take some
time. Once this has completed, you can verify that FiftyOne is installed in
your virtual environment by importing the fiftyone
package:
$ python
Python 3.6.9 (default, Apr 18 2020, 01:56:04)
[GCC 8.4.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>>
>>> import fiftyone as fo
>>>
A successful installation of FiftyOne should result in no output when
fiftyone
is imported.
Quickstart¶
Note
Get started in seconds by running the quickstart!
Dive right into FiftyOne by running the command below. It will download a small dataset, launch the App, and print some suggestions for exploring the dataset!
# Launch the FiftyOne quickstart
fiftyone quickstart
FiftyOne Desktop App¶
By default, the FiftyOne App will be opened in your web browser when you launch it.
However, we also provide a desktop version of the FiftyOne App that you can install as follows:
pip install fiftyone-desktop
Note
Commands like launch_app()
provide an optional desktop
flag that let you control whether to launch
the App in your browser or as a desktop App.
You can also set the desktop_app
flag of your
FiftyOne config to use the desktop App by
default.
Troubleshooting¶
If you run into any installation issues, review the suggestions below or check the troubleshooting page for more details.
Note
Most installation issues can be fixed by upgrading some packages and then rerunning the FiftyOne install:
pip install --upgrade pip setuptools wheel
pip install fiftyone
Mac users:
You must have the XCode Command Line Tools package installed on your machine. You likely already have it, but if you encounter an error message like
error: command 'clang' failed with exit status 1
, then you may need to install it viaxcode-select --install
, or see this page for other options.
Linux users:
The
psutil
package may require Python headers to be installed on your system. On Debian-based distributions, these are available in thepython3-dev
package.If you encounter an error related to MongoDB failing to start, such as
Could not find mongod
, you may need to install additional packages. See the troubleshooting page for details.
Windows users:
If you encounter errors related to missing
msvcp140.dll
, you will need to install the 64-bit Visual Studio 2015 C++ redistributable library, available here (choose the x64 version).
Installing extra packages¶
Various tutorials and guides that we provide on this site require additional
packages in order to run. If you encounter a missing package, you will see
helpful instructions on what you need to install. Alternatively, you can
preemptively install what you’ll need by installing the following additional
packages via pip
in your virtual environment:
ipython
to follow along with interactive examples more easily (note that a system-wide IPython installation will not work in a virtual environment, even if it is accessible)tensorflow
for examples requiring TensorFlow. The installation process can vary depending on your system, so consult the Tensorflow documentation for specific instructions.tensorflow-datasets
for examples that rely on loading TensorFlow datasetstorch
andtorchvision
for examples requiring PyTorch. The installation process can vary depending on your system, so consult the PyTorch documentation for specific instructions.
For your own work, FiftyOne does not strictly require any of these packages, so you can install only what you need.
Upgrading FiftyOne¶
Passing the --upgrade
(or -U
) option to pip install
can be used to
upgrade an existing FiftyOne installation:
pip install --upgrade fiftyone
Uninstalling FiftyOne¶
FiftyOne and all of its subpackages can be uninstalled with:
pip uninstall fiftyone fiftyone-brain fiftyone-db voxel51-eta
If you installed the optional desktop App, you can uninstall that via:
pip uninstall fiftyone-desktop