https://github.com/xl0/tidygrad

A tidy library for gradient-based optimization
https://github.com/xl0/tidygrad

Last synced: 17 days ago
JSON representation

A tidy library for gradient-based optimization

• Host: GitHub
• URL: https://github.com/xl0/tidygrad
• Owner: xl0
• License: mit
• Created: 2023-10-06T14:41:14.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2023-12-23T12:51:03.000Z (about 1 year ago)
• Last Synced: 2024-10-30T08:26:02.559Z (2 months ago)
• Language: Jupyter Notebook
• Homepage: https://xl0.github.io/tidygrad
• Size: 2.06 MB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
TidyGrad

================

# TidyGrad \| [Documentation](https://xl0.github.io/tidygrad/) \| [Discord](https://discord.gg/qBaqauUWXP)

A tidy library for gradient-based optimization

![Tests](https://github.com/xl0/tidygrad/actions/workflows/test.yaml/badge.svg)

## Install

``` sh

pip install -e tidygrad

```

## Dev

``` sh

pip install -e .[dev] # Local install with dev dependencies

```

- Hack

- Hack

- Hack

- (edit and run the notebooks in the `./nbs` directory).

``` sh

nbdev_prepare

```

`nbdev_prepare` will:

- Export all norebooks into the `./tidygrad` directory.

  - Note: the notebooks themselves have an export cell, so they are

    exported every time you run them.

- Run all notebooks (equivalent of testing)

- Generate REDME.md from the index.ipynb

- Generate the docs

## How to use

``` python

# Later

```