google-metrax 0.2.1

A centralized JAX metrics library.

metrax

metrax is a library with standard eval metrics implementations in JAX.

Vision

While the JAX ecosystem is powerful, it currently lacks a core evaluation metrics library. This absence presents challenges for users transitioning from other frameworks like TensorFlow or PyTorch, which offer built-in metrics reporting capabilities.

To address these challenges, we introduced metrax, a standalone JAX model evaluation library that:

• Provides essential predefined metrics: Includes metrics commonly used to evaluate various machine learning models (classification, regression, recommendation, and language modeling), with the flexibility to add more in the future.
• Leverages existing library as a foundation: Builds upon the robust CLU library, ensuring compatibility and consistency in distributed and scaled training environments.
• Is developed on GitHub first and is used by several Google core products.

Please refer to the readthedocs page of the library for more information.

Installation

Install the package by installing the PyPi release.

pip install google-metrax

Development

Install the development dependencies:

pip install ".[dev]"

Run the tests:

pytest src/metrax

Develop the docs locally:

pip install ".[docs]"
sphinx-build ./docs /tmp/metrax_docs
python -m http.server --directory /tmp/metrax_docs

Citing Metrax

To cite Metrax please use the citation:

@software{metrax2024,
  title={Metrax},
  author={Jiwon Shin, Jeff Carpenter, et al.},
  year={2024},
  howpublished={\url{https://github.com/google/metrax}},
}