Thomas commited on
Commit
e14cef5
·
1 Parent(s): 51dd6a0

update readme to be able to run notebooks locally

Browse files
Files changed (2) hide show
  1. README.md +7 -3
  2. requirements.txt +2 -1
README.md CHANGED
@@ -8,10 +8,14 @@ pinned: false
8
  ---
9
 
10
  # Submission API
11
- ## Dev locally
12
- To develop locally:
13
  - `docker build -t myname .`
14
  - `docker run -d --name myname -p 7860:7860 myname`
15
  - then access the api locally through: http://0.0.0.0:7860/
16
 
17
-
 
 
 
 
 
8
  ---
9
 
10
  # Submission API
11
+ ## API locally
12
+ To run API locally:
13
  - `docker build -t myname .`
14
  - `docker run -d --name myname -p 7860:7860 myname`
15
  - then access the api locally through: http://0.0.0.0:7860/
16
 
17
+ ## develop locally the notebooks
18
+ - create a virtual environment in the repo: `python -m venv venv`
19
+ - activate it: `source venv/bin/activate`
20
+ - now that you are in your virtual env, install all the mandatory librairies: `pip install -r requirements.txt`
21
+ You should be able to run the notebooks locally 🔥
requirements.txt CHANGED
@@ -7,4 +7,5 @@ pydantic>=1.10.0
7
  python-dotenv>=1.0.0
8
  gradio>=4.0.0
9
  requests>=2.31.0
10
- librosa==0.10.2.post1
 
 
7
  python-dotenv>=1.0.0
8
  gradio>=4.0.0
9
  requests>=2.31.0
10
+ librosa==0.10.2.post1
11
+ ipywidgets==8.1.5