Project FiftyOne.

Clone the repository:

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

and install it:

bash install.bash

We strongly recommend that you install FiftyOne in a virtual environment to maintain a clean workspace.

If you are a developer contributing to FiftyOne or generating its documentation from source, you should perform a developer installation using the -d flag of the install script:

bash install.bash -d

You should also checkout the Developer's Guide to get started.

Get your feet wet with FiftyOne by running some of examples in the examples folder.

Installing FiftyOne automatically installs fiftyone, a command-line interface (CLI) for interacting with FiftyOne. To explore the CLI, type fiftyone --help.

This project uses Sphinx-Napoleon to generate its documentation from source.

To generate the documentation, you must install the developer dependencies by running the install.bash script with the -d flag.

Then you can generate the docs by running:

bash docs/generate_docs.bash

To view the documentation, open the docs/build/html/index.html file in your browser.

The Developer's Guide has more information on working with the documentation.

pip uninstall fiftyone

Copyright 2017-2020, Voxel51, Inc.
voxel51.com