Skip to content

Commit

Permalink
Merge pull request #372 from particle1331/dev
Browse files Browse the repository at this point in the history 
Minor improvements transformers & PDM migration
  • Loading branch information
@particle1331
particle1331 committed Jun 14, 2024
2 parents d0d58e9 + dd87551 commit 1ccff5b
Show file tree
Hide file tree
Showing 13 changed files with 58,989 additions and 58,077 deletions.
1 change: 1 addition & 0 deletions .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -132,3 +132,4 @@ trained_models/
data/
lightning_logs/
TODO.md
.pdm-python
11 changes: 0 additions & 11 deletions Pipfile
View file

This file was deleted.

20 changes: 0 additions & 20 deletions Pipfile.lock
View file

This file was deleted.

86 changes: 49 additions & 37 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,62 +1,74 @@
# OK Transformer

[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fparticle1331%2Fok-transformer%2Fbadge%3Fref%3Dmaster&label=build&logo=none)](https://actions-badge.atrox.dev/particle1331/ok-transformer/goto?ref=master)
![Last Commit](https://img.shields.io/github/last-commit/particle1331/ok-transformer/master)
![python](https://img.shields.io/github/pipenv/locked/python-version/particle1331/ok-transformer)
[![build-status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fparticle1331%2Fok-transformer%2Fbadge%3Fref%3Dmaster&label=build&logo=none)](https://actions-badge.atrox.dev/particle1331/ok-transformer/goto?ref=master)
![last-commit](https://img.shields.io/github/last-commit/particle1331/ok-transformer/master)
![python](https://shields.io/badge/python-3.10%20-blue)
![jupyter-book](https://github.com/executablebooks/jupyter-book/raw/master/docs/images/badge.svg)
[![Stars](https://img.shields.io/github/stars/particle1331/ok-transformer?style=social)](https://github.com/particle1331/ok-transformer)
[![stars](https://img.shields.io/github/stars/particle1331/ok-transformer?style=social)](https://github.com/particle1331/ok-transformer)

Entry point: [**OK Transformer** website](https://particle1331.github.io/ok-transformer/intro.html)

<br>

A collection of self-contained notebooks on topics in machine
learning engineering and operations. I try to cover things that
come up often as building blocks for other projects or architectures.
Or on topics where I want to [clear up my understanding](http://www.paulgraham.com/words.html),
or have [details to explore](http://www.paulgraham.com/getideas.html).
A collection of self-contained notebooks on machine learning theory, engineering, and operations. I try to cover topics that frequently come up as building blocks for applications or further theory. I also explore areas where I want to [clarify my understanding](http://www.paulgraham.com/words.html) or [delve into details](http://www.paulgraham.com/getideas.html) that I personally find interesting or intriguing.

The notebooks
should ideally run end-to-end with reproducible results between
runs. It is expected that output values may change as there
are external dependencies such as hardware and dataset versions,
runs. Exact output values may change due to
external dependencies such as hardware and changing dataset versions,
but the conclusions should still generally hold. Please open an issue
if you find that this is not the case (as I oftentimes do)!
if you find that this is not the case (as I often do)!

<br>

## Making a local build

```
git clone git@github.com:particle1331/ok-transformer.git
cd ok-transformer
pip install -r requirements-build.txt
make docs
git clone git@github.com:particle1331/ok-transformer.git && cd ok-transformer
pip install --user tox
tox -e build
```

## Dependencies
## Running the notebooks

The notebooks can be found in `docs/nb`.
A virtual environment for running the notebooks can be
created using [`pdm`](https://github.com/pdm-project/pdm)
(use this as jupyter kernel):

```
pip install -U pdm
pdm venv create
pdm venv activate
pdm install
```

The following libraries (specified in `pdm.lock`) will be installed:

```text
docker 5.0.3
docker-compose 1.25.5
fastapi 0.75.2
keras 2.8.0
matplotlib 3.5.1
mlflow 1.26.1
numpy 1.22.4
optuna 2.10.0
pandas 1.4.2
pipenv 2022.6.7
prefect 2.0b5
scikit-learn 1.0.2
seaborn 0.11.2
tensorflow-datasets 4.5.2
tensorflow-macos 2.8.0
tensorflow-metal 0.4.0
torch 2.0.0
torchvision 0.14.0
uvicorn 0.17.6
xgboost 1.6.0.dev0
╭────────────────────────────────────┬────────────────╮
│ fastapi │ 0.111.0 │
│ Flask │ 3.0.3 │
│ keras │ 2.15.0 │
│ matplotlib │ 3.9.0 │
│ mlflow │ 2.13.2 │
│ numpy │ 1.26.4 │
│ optuna │ 3.6.1 │
│ pandas │ 2.2.2 │
│ scikit-learn │ 1.5.0 │
│ scipy │ 1.13.1 │
│ seaborn │ 0.13.2 │
│ tensorflow │ 2.15.1 │
│ tensorflow-datasets │ 4.9.6 │
│ tensorflow-estimator │ 2.15.0 │
│ torch │ 2.3.1 │
│ torchaudio │ 2.3.1 │
│ torchinfo │ 1.8.0 │
│ torchmetrics │ 1.4.0.post0 │
│ torchvision │ 0.18.1 │
│ uvicorn │ 0.30.1 │
│ xgboost │ 2.0.3 │
╰────────────────────────────────────┴────────────────╯
```

## Hardware
Expand Down
53 changes: 27 additions & 26 deletions docs/intro.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ $ ok-transformer --help
Exploring machine learning engineering and operations. ❚
```

[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fparticle1331%2Fok-transformer%2Fbadge%3Fref%3Dmaster&label=build&logo=none)](https://actions-badge.atrox.dev/particle1331/ok-transformer/goto?ref=master)
![Last Commit](https://img.shields.io/github/last-commit/particle1331/ok-transformer/master)
![python](https://img.shields.io/github/pipenv/locked/python-version/particle1331/ok-transformer)
[![build-status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fparticle1331%2Fok-transformer%2Fbadge%3Fref%3Dmaster&label=build&logo=none)](https://actions-badge.atrox.dev/particle1331/ok-transformer/goto?ref=master)
![last-commit](https://img.shields.io/github/last-commit/particle1331/ok-transformer/master)
![python](https://shields.io/badge/python-3.10%20-blue)
![jupyter-book](https://github.com/executablebooks/jupyter-book/raw/master/docs/images/badge.svg)
[![Stars](https://img.shields.io/github/stars/particle1331/ok-transformer?style=social)](https://github.com/particle1331/ok-transformer)
[![stars](https://img.shields.io/github/stars/particle1331/ok-transformer?style=social)](https://github.com/particle1331/ok-transformer)



Expand All @@ -31,28 +31,29 @@ Effect of batch normalization on the magnitude of preactivation gradients.
## Dependencies

```text
docker 5.0.3
docker-compose 1.25.5
fastapi 0.75.2
keras 2.8.0
matplotlib 3.5.1
mlflow 1.26.1
numpy 1.22.4
optuna 2.10.0
pandas 1.4.2
pipenv 2022.6.7
prefect 2.0b5
scikit-learn 1.0.2
seaborn 0.11.2
tensorflow-datasets 4.5.2
tensorflow-macos 2.8.0
tensorflow-metal 0.4.0
torch 2.0.0
torchaudio 2.0.1
torchmetrics 0.11.4
torchvision 0.15.1
uvicorn 0.17.6
xgboost 1.6.0.dev0
╭────────────────────────────────────┬────────────────╮
│ fastapi │ 0.111.0 │
│ Flask │ 3.0.3 │
│ keras │ 2.15.0 │
│ matplotlib │ 3.9.0 │
│ mlflow │ 2.13.2 │
│ numpy │ 1.26.4 │
│ optuna │ 3.6.1 │
│ pandas │ 2.2.2 │
│ scikit-learn │ 1.5.0 │
│ scipy │ 1.13.1 │
│ seaborn │ 0.13.2 │
│ tensorflow │ 2.15.1 │
│ tensorflow-datasets │ 4.9.6 │
│ tensorflow-estimator │ 2.15.0 │
│ torch │ 2.3.1 │
│ torchaudio │ 2.3.1 │
│ torchinfo │ 1.8.0 │
│ torchmetrics │ 1.4.0.post0 │
│ torchvision │ 0.18.1 │
│ uvicorn │ 0.30.1 │
│ xgboost │ 2.0.3 │
╰────────────────────────────────────┴────────────────╯
```

## Hardware
Expand Down

0 comments on commit 1ccff5b

Please sign in to comment.