Model analysis tools for TensorFlow
Switch branches/tags
Clone or download
Latest commit 349d4ff Nov 5, 2018

README.md

TensorFlow Model Analysis PyPI

TensorFlow Model Analysis (TFMA) is a library for evaluating TensorFlow models. It allows users to evaluate their models on large amounts of data in a distributed manner, using the same metrics defined in their trainer. These metrics can be computed over different slices of data and visualized in Jupyter notebooks.

TFMA Slicing Metrics Browser

Caution: TFMA may introduce backwards incompatible changes before version 1.0.

Installation

The recommended way to install TFMA is using the PyPI package:

pip install tensorflow-model-analysis

Currently, TFMA requires that TensorFlow is installed but does not have an explicit dependency on the TensorFlow PyPI package. See the TensorFlow install guides for instructions.

To enable TFMA visualization in Jupyter Notebook:

  jupyter nbextension enable --py widgetsnbextension
  jupyter nbextension install --py --symlink tensorflow_model_analysis
  jupyter nbextension enable --py tensorflow_model_analysis

Note: If Jupyter notebook is already installed in your home directory, add --user to these commands. If Jupyter is installed as root, or using a virtual environment, the parameter --sys-prefix might be required.

Dependencies

Apache Beam is required to run distributed analysis. By default, Apache Beam runs in local mode but can also run in distributed mode using Google Cloud Dataflow. TFMA is designed to be extensible for other Apache Beam runners.

Getting Started

For instructions on using TFMA, see the get started guide and try out the extensive end-to-end example.

Compatible Versions

The following table is the TFMA package versions that are compatible with each other. This is determined by our testing framework, but other untested combinations may also work.

tensorflow-model-analysis tensorflow apache-beam[gcp]
GitHub master 1.9 2.6.0
0.9.2 1.9 2.6.0
0.9.1 1.10 2.6.0
0.9.0 1.9 2.5.0
0.6.0 1.6 2.4.0

Questions

Please direct any questions about working with TFMA to Stack Overflow using the tensorflow-model-analysis tag.