Move README + add refs (#3319)

facebookresearch · Dec 22, 2020 · 6acaa39 · 6acaa39
1 parent 112493c
commit 6acaa39
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 0 deletions.
diff --git a/parlai/crowdsourcing/tasks/README.md → parlai/crowdsourcing/README.md b/parlai/crowdsourcing/tasks/README.md → parlai/crowdsourcing/README.md
diff --git a/parlai/crowdsourcing/tasks/acute_eval/README.md b/parlai/crowdsourcing/tasks/acute_eval/README.md
@@ -27,6 +27,8 @@ The `run.py` script is designed to allow you to run this entire task from comman
     python parlai/crowdsourcing/tasks/acute_eval/run.py \
     mephisto.blueprint.pairings_filepath=${REPO_FOLDER}/parlai/crowdsourcing/tasks/acute_eval/pairings.jsonl
 
+**NOTE**: See [parlai/crowdsourcing/README.md](https://github.com/facebookresearch/ParlAI/blob/master/parlai/crowdsourcing/README.md) for general tips on running `parlai.crowdsourcing` tasks, such as how to specify your own YAML file of configuration settings, how to run tasks live, how to set parameters on the command line, etc.
+
 ## Formatting conversation data
 
 This task code assumes that you've parsed and saved your collected conversations in a simple .jsonl format. The path to this file should be passed in as `mephisto.blueprint.pairings_filepath=${PATH_TO_FILE}`.

diff --git a/parlai/crowdsourcing/tasks/chat_demo/README.md b/parlai/crowdsourcing/tasks/chat_demo/README.md
@@ -3,3 +3,5 @@
 Chat task using two ParlAI-style agents. Code can be extended to change the number of human agents or to add bot agents. See the Mephisto [README](https://github.com/facebookresearch/Mephisto/blob/master/examples/parlai_chat_task_demo/README.md) for more details.
 
 Since this task is imported from the Mephisto repo, `run.py` will look in `${MEPHISTO_REPO}/examples/parlai_chat_task_demo/conf/` for YAML configuration files by default. See [here](https://github.com/facebookresearch/ParlAI/tree/master/parlai/crowdsourcing/tasks#specifying-your-own-yaml-file) for how to specify a custom folder for configuration files.
+
+**NOTE**: See [parlai/crowdsourcing/README.md](https://github.com/facebookresearch/ParlAI/blob/master/parlai/crowdsourcing/README.md) for general tips on running `parlai.crowdsourcing` tasks, such as how to specify your own YAML file of configuration settings, how to run tasks live, how to set parameters on the command line, etc.
diff --git a/parlai/crowdsourcing/tasks/fast_acute/README.md b/parlai/crowdsourcing/tasks/fast_acute/README.md
@@ -8,6 +8,8 @@ The scripts in this directory will allow you to run all the steps of [ACUTE-Eval
 
 Both types are discussed below.
 
+**NOTE**: See [parlai/crowdsourcing/README.md](https://github.com/facebookresearch/ParlAI/blob/master/parlai/crowdsourcing/README.md) for general tips on running `parlai.crowdsourcing` tasks, such as how to specify your own YAML file of configuration settings, how to run tasks live, how to set parameters on the command line, etc.
+
 ## How to run Fast ACUTE if you need to produce model self-chats
 
 ### 1. Choose the self-chat task

diff --git a/parlai/crowdsourcing/tasks/turn_annotations/README.md b/parlai/crowdsourcing/tasks/turn_annotations/README.md
@@ -2,6 +2,8 @@
 
 This task will collect conversations between a human and a model. After each response by the model, the human will be prompted to annotate the model's response by selecting checkboxes that represent customizable attributes of that response.
 
+**NOTE**: See [parlai/crowdsourcing/README.md](https://github.com/facebookresearch/ParlAI/blob/master/parlai/crowdsourcing/README.md) for general tips on running `parlai.crowdsourcing` tasks, such as how to specify your own YAML file of configuration settings, how to run tasks live, how to set parameters on the command line, etc.
+
 ## Launching
 
 Call `run.py` to run this task with the default parameters, as set by `conf/example.yaml`.

diff --git a/parlai/crowdsourcing/tasks/turn_annotations_static/README.md b/parlai/crowdsourcing/tasks/turn_annotations_static/README.md
@@ -12,3 +12,5 @@ Two variants of the blueprint are supported:
 For both variants of the blueprint, it is required to pass in your own file of conversations with `mephisto.blueprint.data_jsonl=${PATH_TO_CONVERSATIONS}`.
 
 See `turn_annotations_blueprint.py` for various parameters of this task, including passing in custom annotation bucket definitions using the `annotation_buckets` YAML flag, being able to group multiple conversations into one HIT using the `subtasks_per_unit` flag, passing in onboarding data with answers, and being able to ask only for the final utterance as an annotation.
+
+**NOTE**: See [parlai/crowdsourcing/README.md](https://github.com/facebookresearch/ParlAI/blob/master/parlai/crowdsourcing/README.md) for general tips on running `parlai.crowdsourcing` tasks, such as how to specify your own YAML file of configuration settings, how to run tasks live, how to set parameters on the command line, etc.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -3,3 +3,5 @@
		Chat task using two ParlAI-style agents. Code can be extended to change the number of human agents or to add bot agents. See the Mephisto [README](https://github.com/facebookresearch/Mephisto/blob/master/examples/parlai_chat_task_demo/README.md) for more details.

		Since this task is imported from the Mephisto repo, `run.py` will look in `${MEPHISTO_REPO}/examples/parlai_chat_task_demo/conf/` for YAML configuration files by default. See [here](https://github.com/facebookresearch/ParlAI/tree/master/parlai/crowdsourcing/tasks#specifying-your-own-yaml-file) for how to specify a custom folder for configuration files.

		NOTE: See [parlai/crowdsourcing/README.md](https://github.com/facebookresearch/ParlAI/blob/master/parlai/crowdsourcing/README.md) for general tips on running `parlai.crowdsourcing` tasks, such as how to specify your own YAML file of configuration settings, how to run tasks live, how to set parameters on the command line, etc.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -12,3 +12,5 @@ Two variants of the blueprint are supported:
		For both variants of the blueprint, it is required to pass in your own file of conversations with `mephisto.blueprint.data_jsonl=${PATH_TO_CONVERSATIONS}`.

		See `turn_annotations_blueprint.py` for various parameters of this task, including passing in custom annotation bucket definitions using the `annotation_buckets` YAML flag, being able to group multiple conversations into one HIT using the `subtasks_per_unit` flag, passing in onboarding data with answers, and being able to ask only for the final utterance as an annotation.

		NOTE: See [parlai/crowdsourcing/README.md](https://github.com/facebookresearch/ParlAI/blob/master/parlai/crowdsourcing/README.md) for general tips on running `parlai.crowdsourcing` tasks, such as how to specify your own YAML file of configuration settings, how to run tasks live, how to set parameters on the command line, etc.