Skip to content
ETA: Extensible Toolkit for Analytics
Python Shell
Branch: develop
Clone or download
brimoor Merge pull request #291 from voxel51/ffmpeg-fixes
ffmpeg fixes for strange video types
Latest commit 34e21e7 Aug 21, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs updating message about CUDA-TF support Jul 23, 2019
eta Merge pull request #291 from voxel51/ffmpeg-fixes Aug 21, 2019
examples
tensorflow
.gitignore cleaning up gitignore Jan 13, 2019
.gitmodules adding tensorflow/models as submodule Apr 25, 2019
LICENSE replacing LLC with Inc. Dec 14, 2018
README.md documentating lite install option in README May 23, 2019
config-example.json adding patterns field to default ETA config May 6, 2019
install.bash supporting CUDA 10 installs Jul 23, 2019
pylintrc customizing pylint Nov 6, 2017
requirements.txt
setup.cfg adding lint configuration files to the repo and updating linting guide Nov 6, 2017
setup.py

README.md

ETA: Extensible Toolkit for Analytics

An open and extensible computer vision, machine learning and video analytics infrastructure.

This project is supported by the NIST Public Safety Innovation Accelerator Program.

eta-infrastructure.png

Requirements

The ETA package requires the following external dependencies:

ETA is very portable:

  • Installable on Mac or Linux
  • Supports both Python 2.7.X and Python 3.6.X
  • Supports both OpenCV 2.4+ and OpenCV 3.0+
  • Supports both CPU and GPU execution
  • Supports both CUDA 8 and CUDA 9 (for GPU installations)

Installation

  1. Activate a virtual environment (optional but highly recommended)

  2. Clone the repository:

git clone https://github.com/voxel51/eta
cd eta
  1. Run the install script:
bash install.bash

Depending on your Python environment, you may need to run the script with sudo privileges. Note that the install script supports flags that control things like (on macOS) whether port or brew is used to install packages. Run bash install.bash -h for more information.

The script inspects your system to see if CUDA is installed, and, if it is, TensorFlow is installed with GPU support. In particular, if CUDA 9 is found, the latest version of the tensorflow-gpu package is installed, and if CUDA 8 is found, tensorflow-gpu 1.4 is installed.

Note that ETA is installed in editable via pip install -e ., so don't delete the directory after installation!

Lite installation

Some ETA users are only interested in using the core ETA library defined in the eta.core package. In such cases, you can perform a lite installation using the -l flag of the install script:

bash install.bash -l

Lite installation omits submodules and other large dependencies that are not required in order for the core library to function.

Setting up your execution environment

When the root eta package is imported, it tries to read the eta/config.json file to configure various package-level constants. Many advanced ETA features such as pipeline building, model management, etc. require a properly configured environment to function.

To setup your environment, create a copy the example configuration file

cp config-example.json config.json

If desired, you can edit your config file to customize the various paths, change default constants, add environment variables, customize your default PYTHONPATH, and so on. You can also add additional paths to the module_dirs, pipeline_dirs, and models_dirs sections to expose custom modules, pipelines, and models to your system.

Note that, when the config file is loaded, any {{eta}} patterns in directory paths are replaced with the absolute path to the ETA repository on your machine.

The default config includes the eta/modules, eta/pipelines, and eta/models directories on your module, pipeline, and models search paths, respectively. These directories contain the necessary information to run the standard analytics exposed by the ETA library. In addition, the relative paths ./modules, ./pipelines, and ./models are added to their respective paths to support the typical directory structure that we adopt for our custom projects.

The eta command-line utility

When you installed ETA, an eta command-line utility was added to your path. This utility provides access to many usefuel features of ETA, including building pipelines from requests, running pipelines, and generating module metadata files.

To learn more about the supported operations and their syntaxes, type

eta --help

Testing your installation

To test your installation, run some of these examples.

Organization

The ETA package is organized as described below. For more information about the design and function of the various ETA components, read the documentation in the docs folder.

  • eta/classifiers/: interfaces for common classifiers

  • eta/core/: the core ETA library, which includes utilities for working with images, videos, embeddings, and much more.

  • eta/detectors/: interfaces for common detectors

  • eta/models/: library of ML models. The manifest.json file in this folder enumerates the models, which are downloaded to this folder as needed. See the Models developer's guide for more information about ETA's model registry.

  • eta/modules/: library of video processing/analytics modules. See the Module developer's guide for more information about ETA modules.

  • eta/pipelines/: library of video processing/analytics pipelines. See the Pipeline developer's guide for more information about ETA pipelines.

  • eta/resources/: resources such as media, templates, etc.

In addition, ETA makes use of the following external dependencies:

  • tensorflow/: Third-party TensorFlow repositories that ETA builds upon

Uninstallation

pip uninstall eta

Copyright

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

Brian Moore, brian@voxel51.com

You can’t perform that action at this time.