# AI Helpers - Jax Utils

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=ai-helpers_jax-utils&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=ai-helpers_jax-utils)
[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=ai-helpers_jax-utils&metric=bugs)](https://sonarcloud.io/summary/new_code?id=ai-helpers_jax-utils)
[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=ai-helpers_jax-utils&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=ai-helpers_jax-utils)

`jax-utils` is a Python module that provides a collection of utilities to simplify and enhance the use of JAX. These utilities are designed to make working with JAX more efficient and to reduce boilerplate code.

## Table of Contents

- [AI Helpers - Jax Utils](#ai-helpers---jax-utils)
  - [Table of Contents](#table-of-contents)
  - [Installation](#installation)
  - [Getting Started](#getting-started)
  - [Utilities](#utilities)
  - [Examples](#examples)
  - [Contributing](#contributing)

## Installation

You can install the `jax-utils` module via pip:

```bash
pip install ai-helpers-jax-utils
```

## Getting Started

First, import the module in your Python script:

```python
import jax_utils as ju
```

Now you can use the utilities provided by `jax-utils`.

## Utilities
 > TODO

## Examples
> TODO

## Contributing

We welcome contributions to `jax-utils`. To contribute, please follow these steps:

1. Fork the repository.
2. Create a new branch (`git checkout -b feature-branch`).
3. Make your changes.
4. Commit your changes (`git commit -am 'Add some feature'`).
5. Push to the branch (`git push origin feature-branch`).
6. Create a new Pull Request.

Please ensure your code follows the project's coding standards and includes appropriate tests.