Skip to main content

metrax

CI status Documentation Status pypi Open In Colab

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}},
}

Metadata

Release files for google-metrax 0.2.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for google-metrax 0.2.4
File Size Uploaded
google_metrax-0.2.4.tar.gz 32.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for google-metrax 0.2.4
File Interpreter ABI Platform
google_metrax-0.2.4-py3-none-any.whl Python 3 none any Details

Total release size: 79.7 kB

Release files / google_metrax-0.2.4.tar.gz

Download URL google_metrax-0.2.4.tar.gz
Size 32.6 kB
Tags Source
SHA-256 checksum
How to use checksums
5f8572f4cf612ded3b81b75dffb1f296e12e7d8cfae9d2237e2561357c5c4dac
BLAKE2b-256 checksum
How to use checksums
3643c5ba12c47422848150ba7c6ac46c5a01ad165c43fdd5a12fed83867945ad
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.7

Release files / google_metrax-0.2.4-py3-none-any.whl

Download URL google_metrax-0.2.4-py3-none-any.whl
Size 47.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
98233aed2d9dfd98d510b8df16550d935b8aa9d818eef5017d5d301b4ba4f5f5
BLAKE2b-256 checksum
How to use checksums
9bf9462bd0faee88fbcb303798b464febe0df3cd72a043d17ef7a9b9cf0e9102
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.7

Release history Release notifications | RSS feed

This release

0.2.4 This release

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.4

1 release file

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

0.0.9

2 release files

0.0.8

2 release files

0.0.7

2 release files

0.0.6

2 release files

0.0.5

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page