Metadata-Version: 2.4
Name: lucidlearn
Version: 0.0.1
Summary: A transparent, concise machine learning framework in JAX inspired by `miniai` from `fastai/course22p2` and optimized for efficient TPU usage.
Author-email: Frenio Redeker <f.redeker@gmail.com>
License: Apache-2.0
Project-URL: Repository, https://github.com/frenio/lucidlearn
Project-URL: Documentation, https://frenio.github.io/lucidlearn/
Keywords: nbdev,jax,deep-learning,tpu
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: jax
Requires-Dist: optax
Requires-Dist: torch
Requires-Dist: torchvision
Requires-Dist: torchmetrics
Requires-Dist: matplotlib
Dynamic: license-file

# lucidlearn


<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->

This file will become your README and also the index of your
documentation.

## Developer Guide

If you are new to using `nbdev` here are some useful pointers to get you
started.

### Install lucidlearn in Development mode

``` sh
# make sure lucidlearn package is installed in development mode
$ pip install -e .

# make changes under nbs/ directory
# ...

# compile to have changes apply to lucidlearn
$ nbdev_prepare
```

## Usage

### Installation

Install latest from the GitHub
[repository](https://github.com/frenio/lucidlearn):

``` sh
$ pip install git+https://github.com/frenio/lucidlearn.git
```

or from [conda](https://anaconda.org/frenio/lucidlearn)

``` sh
$ conda install -c frenio lucidlearn
```

or from [pypi](https://pypi.org/project/lucidlearn/)

``` sh
$ pip install lucidlearn
```

### Documentation

Documentation can be found hosted on this GitHub
[repository](https://github.com/frenio/lucidlearn)’s
[pages](https://frenio.github.io/lucidlearn/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/frenio/lucidlearn) and
[pypi](https://pypi.org/project/lucidlearn/) respectively.

## How to use

Fill me in please! Don’t forget code examples:

``` python
1+1
```

    2
