alessandro trinca tornidor commited on
Commit
b57aef5
1 Parent(s): b5c05cd

doc: update README.md with details about pytorch versions, instructions about docker container build

Browse files
Files changed (1) hide show
  1. README.md +22 -3
README.md CHANGED
@@ -20,7 +20,8 @@ You should be able to run it locally without any major issues as long as you’r
20
 
21
  ## Changes on [trincadev's](https://github.com/trincadev/) [repository](https://github.com/trincadev/ai-pronunciation-trainer)
22
 
23
- I upgraded the frontend (jquery@3.7.1, bootstrap@5.3.3) and backend (pytorch==2.2.2, torchaudio==2.2.2) libraries. Should work also with pytorch > 2.2.2, but right now I can't try it on macOS intel.
 
24
 
25
  ### E2E tests with playwright
26
 
@@ -47,11 +48,29 @@ pnpm playwright test
47
 
48
  ### TODO
49
 
50
- - add more e2e tests with playwright
51
  - move from pytorch to onnxruntime (if possible)
52
  - refactor frontend with something more modern (e.g. vuejs)
53
  - refactor css style with tailwindcss
54
- - add an updated online version on Cloudflare or AWS
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
55
 
56
  ## Online version
57
 
 
20
 
21
  ## Changes on [trincadev's](https://github.com/trincadev/) [repository](https://github.com/trincadev/ai-pronunciation-trainer)
22
 
23
+ I upgraded the frontend (jquery@3.7.1, bootstrap@5.3.3) and backend (pytorch==2.5.1, torchaudio==2.5.1) libraries. On macOS intel it's possible to install from [pypi.org](https://pypi.org/project/torch/) only until the library version [2.2.2](https://pypi.org/project/torch/2.2.2/)
24
+ (see [this github issue](https://github.com/instructlab/instructlab/issues/1469) and [this deprecation notice](https://dev-discuss.pytorch.org/t/pytorch-macos-x86-builds-deprecation-starting-january-2024/1690)).
25
 
26
  ### E2E tests with playwright
27
 
 
48
 
49
  ### TODO
50
 
51
+ - add an updated online version on HuggingFace, Cloudflare or AWS
52
  - move from pytorch to onnxruntime (if possible)
53
  - refactor frontend with something more modern (e.g. vuejs)
54
  - refactor css style with tailwindcss
55
+ - add more e2e tests with playwright
56
+
57
+ ## Docker version
58
+
59
+ Build the docker image this way:
60
+
61
+ ```bash
62
+ # clean any old active containers
63
+ docker stop $(docker ps -a -q); docker rm $(docker ps -a -q)
64
+
65
+ # build the base docker image
66
+ docker build . --progress=plain --tag aip_trainer
67
+ ```
68
+
69
+ Run the container (keep it on background) and show logs
70
+
71
+ ```bash
72
+ docker run -d -p 3000:3000 --name aip_trainer aip_trainer;docker logs -f aip_trainer
73
+ ```
74
 
75
  ## Online version
76