Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
added hyperlinks in README
  • Loading branch information
simeon-ned authored Sep 17, 2024
1 parent f256e4f commit ba0afd5
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
</p>


**JaxADi** is a powerful Python library designed to bridge the gap between `casadi.Function` and JAX-compatible functions. By leveraging the strengths of both CasADi and JAX, JAXADI opens up exciting opportunities for building highly efficient, batchable code that can be executed seamlessly across CPUs, GPUs, and TPUs.
**JaxADi** is a Python library designed to bridge the gap between [CasADi](https://web.casadi.org/) based and [JAX](https://jax.readthedocs.io/en/latest/index.html#)-compatible functions. By leveraging the strengths of both CasADi and JAX, JaxADi opens up exciting opportunities for building highly efficient, batchable code that can be executed seamlessly across CPUs, GPUs, and TPUs.

JAXADI can be particularly useful in scenarios involving:
JaxADi can be particularly useful in scenarios involving:

- Robotics simulations
- Optimal control problems
Expand All @@ -19,7 +19,7 @@ JAXADI can be particularly useful in scenarios involving:

## Installation

You can install JAXADI using pip:
You can install JaxADi using pip:
<!-- Change once it will be realeased -->

```bash
Expand All @@ -34,7 +34,7 @@ mamba env create -f environment.yml

## Usage

JAXADI provides a simple and intuitive API:
JaxADi provides a simple and intuitive API:

```python
import casadi as cs
Expand Down Expand Up @@ -65,7 +65,7 @@ output = jax_fn(input_x, input_y)

## Examples

JAXADI comes with several examples to help you get started:
JaxADi comes with several examples to help you get started:

1. [Basic Translation](examples/00_translate.py): Learn how to translate CasADi functions to JAX.

Expand Down Expand Up @@ -113,4 +113,4 @@ This project draws inspiration from [cusadi](https://github.com/se-hwan/cusadi),
For questions, issues, or suggestions, please [open an issue](https://github.com/based-robotics/jaxadi/issues) on our GitHub repository.


We hope JAXADI empowers your numerical computing and optimization tasks! Happy coding!
We hope JaxADi empowers your numerical computing and optimization tasks! Happy coding!

0 comments on commit ba0afd5

Please sign in to comment.