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

Commit

Permalink
Update ReadMe to recommend poetry install for Mephisto (#4612)
Browse files Browse the repository at this point in the history
* Update ReadMe to recommend poetry install for Mephisto

* add install instructions
  • Loading branch information
dexterju27 authored Jul 5, 2022
1 parent 427f1d0 commit 467ad37
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion parlai/crowdsourcing/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
# Crowdsourcing tasks

Code for crowdsourcing tasks that use Mephisto. See the [Mephisto quick start guide](https://github.com/facebookresearch/mephisto/blob/main/docs/quickstart.md) to quickly get started with Mephisto. This README provides a quick overview of how to run crowdsourcing tasks in ParlAI: see the [tutorial](https://github.com/facebookresearch/ParlAI/blob/main/docs/source/tutorial_crowdsourcing.md) for a deeper guide on how to set up and configure new crowdsourcing tasks.
Code for crowdsourcing tasks that use Mephisto. See the [Mephisto quick start guide](https://mephisto.ai/docs/guides/quickstart/) to quickly get started with Mephisto. **Please install Mephisto via poetry to avoid depdency conflits with ParlAI.**
```
# install poetry
$ curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python
# from the root dir, install Mephisto:
$ poetry install
```
This README provides a quick overview of how to run crowdsourcing tasks in ParlAI: see the [tutorial](https://github.com/facebookresearch/ParlAI/blob/main/docs/source/tutorial_crowdsourcing.md) for a deeper guide on how to set up and configure new crowdsourcing tasks.

**NOTE:** `parlai/crowdsourcing/` has taken the place of `parlai/mturk/` as the home for ParlAI crowdsourcing tasks. Information on how to find the old code in `parlai/mturk/` can be find [here](https://github.com/facebookresearch/ParlAI/tree/main/parlai/mturk/README.md).

Expand Down

0 comments on commit 467ad37

Please sign in to comment.