Tristan Thrush commited on
Commit
6d09417
1 Parent(s): 5cac80c

update README

Browse files
Files changed (1) hide show
  1. README.md +5 -5
README.md CHANGED
@@ -12,9 +12,9 @@ license: bigscience-bloom-rail-1.0
12
 
13
  A basic example of dynamic adversarial data collection with a Gradio app.
14
 
15
- *Instructions for someone to use for their own project:*
16
 
17
- **Setting up the Space**
18
  1. Clone this repo and deploy it on your own Hugging Face space.
19
  2. Add one of your Hugging Face tokens to the secrets for your space, with the
20
  name `HF_TOKEN`. Now, create an empty Hugging Face dataset on the hub. Put
@@ -25,7 +25,7 @@ A basic example of dynamic adversarial data collection with a Gradio app.
25
  if you push something to your dataset manually, you need to reboot your space
26
  or it could get merge conflicts when trying to push HIT data.
27
 
28
- **Running Data Collection**
29
  1. On your local repo that you pulled, create a copy of `config.py.example`,
30
  just called `config.py`. Now, put keys from your AWS account in `config.py`.
31
  These keys should be for an AWS account that has the
@@ -33,11 +33,11 @@ A basic example of dynamic adversarial data collection with a Gradio app.
33
  create an mturk requestor account associated with your AWS account.
34
  2. Run `python collect.py` locally.
35
 
36
- **Profit**
37
  Now, you should be watching hits come into your Hugging Face dataset
38
  automatically!
39
 
40
- **Tips and Tricks**
41
  - If you are developing and running this space locally to test it out, try
42
  deleting the data directory that the app clones before running the app again.
43
  Otherwise, the app could get merge conflicts when storing new HITs on the hub.
 
12
 
13
  A basic example of dynamic adversarial data collection with a Gradio app.
14
 
15
+ **Instructions for someone to use for their own project:**
16
 
17
+ *Setting up the Space*
18
  1. Clone this repo and deploy it on your own Hugging Face space.
19
  2. Add one of your Hugging Face tokens to the secrets for your space, with the
20
  name `HF_TOKEN`. Now, create an empty Hugging Face dataset on the hub. Put
 
25
  if you push something to your dataset manually, you need to reboot your space
26
  or it could get merge conflicts when trying to push HIT data.
27
 
28
+ *Running Data Collection*
29
  1. On your local repo that you pulled, create a copy of `config.py.example`,
30
  just called `config.py`. Now, put keys from your AWS account in `config.py`.
31
  These keys should be for an AWS account that has the
 
33
  create an mturk requestor account associated with your AWS account.
34
  2. Run `python collect.py` locally.
35
 
36
+ *Profit*
37
  Now, you should be watching hits come into your Hugging Face dataset
38
  automatically!
39
 
40
+ *Tips and Tricks*
41
  - If you are developing and running this space locally to test it out, try
42
  deleting the data directory that the app clones before running the app again.
43
  Otherwise, the app could get merge conflicts when storing new HITs on the hub.