Skip to content

Commit

Permalink
Restructured Readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
Tim-Salzmann committed Jun 6, 2024
1 parent 6a59c17 commit e91e6c7
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
![L4CasADi CI](https://github.com/Tim-Salzmann/l4casadi/actions/workflows/ci.yaml/badge.svg)
![Downloads](https://img.shields.io/pypi/dm/l4casadi.svg)

**Due to a bug, Hessians for functions with non-scalar outputs were wrong prior to version 1.3.0*

---
# Learning 4 CasADi Framework

Expand All @@ -29,8 +27,8 @@ Talk: [Youtube](https://youtu.be/UYdkRnGr8eM?si=KEPcFEL9b7Vk2juI&t=3348)
- [Projects using L4CasADi](#projects-using-l4casadi)
- [Installation](#installation)
- [Online Learning](#online-learning-and-updating)
- [Naive L4CasADi](#naive-l4casadi)
- [Real-time L4CasADi](#real-time-l4casadi)
- [Naive L4CasADi](#naive-l4casadi) - Use this for small Multi Layer Perceptron Models.
- [Real-time L4CasADi](#real-time-l4casadi) - Use this for fast MPC with Acados.
- [Examples](#examples)

If you use this framework please cite the following two paper
Expand Down Expand Up @@ -108,6 +106,19 @@ E.g. `CUDACXX=<PATH_TO_NVCC> pip install l4casadi --no-build-isolation`.

---

## Quick Start

Defining an L4CasADi model in Python given a pre-defined PyTorch model is as easy as
```python
import l4casadi as l4c

l4c_model = l4c.L4CasADi(pyTorch_model, device='cpu')
```

where the architecture of the PyTorch model is unrestricted and large models can be accelerated with dedicated hardware.

---

## Online Learning and Updating
L4CasADi supports updating the PyTorch model online in the CasADi graph. To use this feature, pass `mutable=True` when
initializing a L4CasADi. To update the model, call the `update` function on the `L4CasADi` object.
Expand Down

0 comments on commit e91e6c7

Please sign in to comment.