Skip to content

Commit 21a63cc

Browse files
committed
add vision section to the README
1 parent 7c875d7 commit 21a63cc

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,18 @@
22

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

5+
## Vision
6+
7+
While the [JAX ecosystem](https://docs.jax.dev/en/latest/) 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.
8+
9+
To address these challenges, we introduced metrax, a standalone JAX model evaluation library that:
10+
* 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.
11+
* Leverages existing library as a foundation: Builds upon the robust [CLU](https://github.com/google/CommonLoopUtils) library, ensuring compatibility and consistency in distributed and scaled training environments.
12+
* Is accessible to both internal and external developers: With a GitHub-first development strategy and daily synchronization to the internal Google systems.
13+
* Is developed on GitHub first and is used by several Google core products.
14+
15+
Please refer to the [readthedocs page](http://metrax.readthedocs.io/) of the library for more information.
16+
517
## Installation
618

719
Install the package by installing the PyPi release.

0 commit comments

Comments
 (0)