Skip to content
This repository has been archived by the owner on Nov 3, 2023. It is now read-only.

Move README and add references to it #3319

Merged
merged 1 commit into from
Dec 22, 2020
Merged

Conversation

EricMichaelSmith
Copy link
Contributor

@EricMichaelSmith EricMichaelSmith commented Dec 21, 2020

This PR moves the main ParlAI crowdsourcing README from parlai/crowdsourcing/tasks/ to parlai/crowdsourcing/ for greater visibility. Within each crowdsourcing task's own README, a link has been added to refer the user back to the main README, for general info on how to specify a custom Hydra YAML file, etc.

Copy link
Contributor

@mwillwork mwillwork left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is fine but I actually meant writing it in the run.py file like this:

To run the task with your own config outside this folder (recommended!)

Use the command formulation below. For more info,

check the README in parlai/crowdsourcing/

python turn_annotations_static/run.py conf= --config-dir <path to directory with a conf/ folder

@EricMichaelSmith
Copy link
Contributor Author

This is fine but I actually meant writing it in the run.py file like this:

To run the task with your own config outside this folder (recommended!)

Use the command formulation below. For more info,

check the README in parlai/crowdsourcing/

python turn_annotations_static/run.py conf= --config-dir <path to directory with a conf/ folder

Hmm - @mwillwork the reason I didn't add those conf instructions to the run.py file itself is because I'd like to keep the instructions for a task centralized in the README, not in the run.py file or anywhere else: I think that'd be a good practice for users to check the README when they start using a task, because that should be the one source of truth. Having multiple sets of documentation there and in every run.py file can easily lead to conflicts as they become out of sync with each other, we forget to update one, etc. But if you feel strongly about this lemme know and I'm happy to reconsider

@EricMichaelSmith EricMichaelSmith merged commit 6acaa39 into master Dec 22, 2020
@EricMichaelSmith EricMichaelSmith deleted the cleaner-READMEs branch December 22, 2020 18:37
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants