alessandro trinca tornidor commited on
Commit
514e91e
·
1 Parent(s): fe7b9b7

docs: updated README.md

Browse files
Files changed (1) hide show
  1. README.md +7 -4
README.md CHANGED
@@ -42,9 +42,12 @@ Currently the best way to exec the project is using the Gradio frontend:
42
  python app.py
43
  ```
44
 
45
- I upgraded the old custom 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/)
46
  (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)).
47
 
 
 
 
48
  ### E2E tests with playwright
49
 
50
  Normally I use Visual Studio Code to write and execute my playwright tests, however it's always possible to run them from cli (from the `static` folder, using a node package manager like `npm` or `pnpm`):
@@ -64,11 +67,11 @@ pnpm playwright test
64
 
65
  ### DONE
66
 
67
- - upgrade jquery>3.x
68
  - upgrade pytorch>2.x
69
  - e2e playwright tests
70
  - add an updated online version (HuggingFace)
71
- - refactor frontend moving from jquery to gradio
72
 
73
  ### TODO
74
 
@@ -80,7 +83,7 @@ pnpm playwright test
80
 
81
  ## Docker version
82
 
83
- Build the docker image this way (right now this version uses the old custom frontend with jquery):
84
 
85
  ```bash
86
  # clean any old active containers
 
42
  python app.py
43
  ```
44
 
45
+ I upgraded the old custom frontend (iQuery@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/)
46
  (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)).
47
 
48
+ In case of missing TTS voices needed by the Text-to-Speech in-browser SpeechSynthesis feature (e.g. on Windows 11 you need to install manually the TTS voices for the languages you need), right now the Gradio frontend raises an alert message with a JavaScript message.
49
+ In this case the TTS in-browser feature isn't usable and the users should use the backend TTS feature.
50
+
51
  ### E2E tests with playwright
52
 
53
  Normally I use Visual Studio Code to write and execute my playwright tests, however it's always possible to run them from cli (from the `static` folder, using a node package manager like `npm` or `pnpm`):
 
67
 
68
  ### DONE
69
 
70
+ - upgrade iQuery>3.x
71
  - upgrade pytorch>2.x
72
  - e2e playwright tests
73
  - add an updated online version (HuggingFace)
74
+ - refactor frontend moving from iQuery to gradio
75
 
76
  ### TODO
77
 
 
83
 
84
  ## Docker version
85
 
86
+ Build the docker image this way (right now this version uses the old custom frontend with jQuery):
87
 
88
  ```bash
89
  # clean any old active containers