lewtun HF staff commited on
Commit
5e588f0
1 Parent(s): 90b6f98

Update README

Browse files
Files changed (1) hide show
  1. README.md +15 -6
README.md CHANGED
@@ -9,11 +9,19 @@ app_file: app.py
9
  pinned: false
10
  ---
11
 
12
- A basic example of an RLHF interface with a Gradio app.
13
 
14
- **Instructions for someone to use for their own project:**
15
 
16
- *Setting up the Space*
 
 
 
 
 
 
 
 
17
 
18
  1. Clone this repo and deploy it on your own Hugging Face space.
19
  2. Add the following secrets to your space:
@@ -38,7 +46,7 @@ python app.py
38
 
39
  The app will then be available at a local address, such as http://127.0.0.1:7860
40
 
41
- *Running Data Collection*
42
 
43
  1. On your local repo that you pulled, create a copy of `config.py.example`,
44
  just called `config.py`. Now, put keys from your AWS account in `config.py`.
@@ -47,11 +55,12 @@ The app will then be available at a local address, such as http://127.0.0.1:7860
47
  create an mturk requestor account associated with your AWS account.
48
  2. Run `python collect.py` locally.
49
 
50
- *Profit*
51
  Now, you should be watching hits come into your Hugging Face dataset
52
  automatically!
53
 
54
- *Tips and Tricks*
 
55
  - Use caution while doing local development of your space and
56
  simultaneously running it on mturk. Consider setting `FORCE_PUSH` to "no" in
57
  your local `.env` file.
 
9
  pinned: false
10
  ---
11
 
12
+ An RLHF interface for data collection with [Amazon Mechanical Turk](https://www.mturk.com) and Gradio.
13
 
14
+ ## Instructions for someone to use for their own project
15
 
16
+ ### Install dependencies
17
+
18
+ First, create a Python virtual environment and install the project's dependencies as follows:
19
+
20
+ ```bash
21
+ python -m pip install -r requirements.txt
22
+ ```
23
+
24
+ ### Setting up the Space
25
 
26
  1. Clone this repo and deploy it on your own Hugging Face space.
27
  2. Add the following secrets to your space:
 
46
 
47
  The app will then be available at a local address, such as http://127.0.0.1:7860
48
 
49
+ ### Running data collection*
50
 
51
  1. On your local repo that you pulled, create a copy of `config.py.example`,
52
  just called `config.py`. Now, put keys from your AWS account in `config.py`.
 
55
  create an mturk requestor account associated with your AWS account.
56
  2. Run `python collect.py` locally.
57
 
58
+ ### Profit
59
  Now, you should be watching hits come into your Hugging Face dataset
60
  automatically!
61
 
62
+ ### Tips and tricks
63
+
64
  - Use caution while doing local development of your space and
65
  simultaneously running it on mturk. Consider setting `FORCE_PUSH` to "no" in
66
  your local `.env` file.