summaryrefslogtreecommitdiff
path: root/README.md
blob: 8eae924a84890706416c34e8a417d70ae3e7cd23 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
# Text Recognizer
Implementing the text recognizer project from the course ["Full Stack Deep Learning Course"](https://fullstackdeeplearning.com/march2019) (FSDL) in PyTorch in order to learn best practices when building a deep learning project. I have expanded on this project by adding additional feature and ideas given by Claudio Jolowicz in ["Hypermodern Python"](https://cjolowicz.github.io/posts/hypermodern-python-01-setup/).

## Prerequisite

### pyenv

[pyenv](https://github.com/pyenv/pyenv) (or similar) and python 3.9.\* installed.

### nox

[nox](https://nox.thea.codes/en/stable/index.html) for linting, formatting, and testing.

### Poetry

[Poetry](https://python-poetry.org/) is a project manager for python.

## Installation

Install poetry and pyenv.

```sh
pyenv local 3.9.\*
make check
make install
```

## Generate Datasets

Download and generate datasets by running:

```sh
make download
make generate
```


## TODO

## Todo
- [ ] remove einops
- [ ] Tests
- [ ] Evaluation
- [ ] Wandb artifact fetcher
- [ ] fix linting