Mephisto

Overview

This release contains a number of Stability and Quality of Life improvements from [`v1.0.0`](https://github.com/facebookresearch/Mephisto/releases/tag/v1.0.0) and [`v1.0.2`](https://github.com/facebookresearch/Mephisto/releases/tag/v1.0.2). The big focus has been on collection success rate, documentation, and various bugfixes.

For those updating from 1.0, see the 1.0.2 changes as well for a complete changelog.

Breaking changes
- Mephisto no longer supports Python 3.7. This is as of 898, wherein to get the ParlAI peer imports working we needed to bump to ParlAI `1.7.0`, which no longer supports Python 3.7.

Big Changes
- When launching on MTurk, Mephisto will request that you run the `mephisto scripts mturk cleanup` script inline before launching. This exercise prevents having long-running tasks that haven't been cleaned up properly. 918
- When jobs have had no activity for a set duration, they'll be shut down automatically (suspecting an issue). 919

Big Fixes
- Lots of documentation, thanks Etesam913!
- Significant fixes to proper execution and state tracking in Mephisto, which should improve stability across all job types (875, 878, 902, 922)
- Major fix for Heroku tasks using the `useMephistoLiveTask` hook, which was causing all messages to be double sent in both directions. (921)


Included PRs

Feature + UX Improvements
* Enhance logging messages with rich by Etesam913 in https://github.com/facebookresearch/Mephisto/pull/869
* Added ability to customize `html-static-task-example` submit button by Etesam913 in https://github.com/facebookresearch/Mephisto/pull/879
* Adds ability to clear onboarding for a worker by Etesam913 in https://github.com/facebookresearch/Mephisto/pull/886
* Adding more general function with better name by mojtaba-komeili in https://github.com/facebookresearch/Mephisto/pull/893
* Making MTurk cleanup run daily per requester by JackUrb in https://github.com/facebookresearch/Mephisto/pull/918
* 12 hour inactivity shutdown by JackUrb in https://github.com/facebookresearch/Mephisto/pull/919

Bugfixes
* [Bugfix] Fixing double update bug on heroku by JackUrb in https://github.com/facebookresearch/Mephisto/pull/921
* Fixing Worker Pool race condition for assignments by JackUrb in https://github.com/facebookresearch/Mephisto/pull/875
* ParlAI Assignment Fixes pt 2 by JackUrb in https://github.com/facebookresearch/Mephisto/pull/878
* Resolving static return status bug by JackUrb in https://github.com/facebookresearch/Mephisto/pull/902
* Make `self.metadata` backward-compatible by chiehminwei in https://github.com/facebookresearch/Mephisto/pull/861
* Finding OSTYPE if not exists by mojtaba-komeili in https://github.com/facebookresearch/Mephisto/pull/892
* fix breaks in create_validation_function for screening units by macota in https://github.com/facebookresearch/Mephisto/pull/864
* Fix mephisto web cli command by Etesam913 in https://github.com/facebookresearch/Mephisto/pull/865
* Removing threadsafety as we already lock connections behind threads by JackUrb in https://github.com/facebookresearch/Mephisto/pull/897
* Extending some 1.1 changes by JackUrb in https://github.com/facebookresearch/Mephisto/pull/922

Testing & DevX
* Add path filter by Etesam913 in https://github.com/facebookresearch/Mephisto/pull/868
* Add cypress test to simple static task by Etesam913 in https://github.com/facebookresearch/Mephisto/pull/881
* fix 874: Upgrade pip and create main_data_directory in Dockerfile by mjkanji in https://github.com/facebookresearch/Mephisto/pull/917
* pre-commit install by mojtaba-komeili in https://github.com/facebookresearch/Mephisto/pull/894
* Some fixes made to run a live demo of Mephisto functionality by JackUrb in https://github.com/facebookresearch/Mephisto/pull/909

Docs + Examples
* Adds cypress section to frontend docs by Etesam913 in https://github.com/facebookresearch/Mephisto/pull/860
* Adds tips/feedback section to docs by Etesam913 in https://github.com/facebookresearch/Mephisto/pull/838
* Add tests to tips example by Etesam913 in https://github.com/facebookresearch/Mephisto/pull/833
* Add searchbar to docs by Etesam913 in https://github.com/facebookresearch/Mephisto/pull/858
* Update searchbar colors by Etesam913 in https://github.com/facebookresearch/Mephisto/pull/863
* Auto Generate Blueprint Documentation by Etesam913 in https://github.com/facebookresearch/Mephisto/pull/870
* Auto Generate Architect Documentation by Etesam913 in https://github.com/facebookresearch/Mephisto/pull/871
* Auto Generate Requester Documentation by Etesam913 in https://github.com/facebookresearch/Mephisto/pull/872
* Auto Generate Provider Documentation by Etesam913 in https://github.com/facebookresearch/Mephisto/pull/873
* Update deploy docs github action to auto-generate docs by Etesam913 in https://github.com/facebookresearch/Mephisto/pull/877
* Add Screening Example by Etesam913 in https://github.com/facebookresearch/Mephisto/pull/883
* Creates a readme for simple_static_task by Etesam913 in https://github.com/facebookresearch/Mephisto/pull/882
* Improve onboarding example by Etesam913 in https://github.com/facebookresearch/Mephisto/pull/887
* Add info on `link_task_source` to docs by Etesam913 in https://github.com/facebookresearch/Mephisto/pull/885
* Update documentation to reflect that make_qualification_dict takes 3 arguments. by xksteven in https://github.com/facebookresearch/Mephisto/pull/908

Dependencies
* Bump terser from 5.12.1 to 5.14.2 in /docs/web by dependabot in https://github.com/facebookresearch/Mephisto/pull/853
* Update `blueprintjs/core` version by pringshia in https://github.com/facebookresearch/Mephisto/pull/876
* Bump oauthlib from 3.2.0 to 3.2.1 by dependabot in https://github.com/facebookresearch/Mephisto/pull/901
* Bump protobuf from 3.19.4 to 3.19.5 by dependabot in https://github.com/facebookresearch/Mephisto/pull/903
* Bump joblib from 1.1.0 to 1.2.0 by dependabot in https://github.com/facebookresearch/Mephisto/pull/904
* Upgrading to poetry 1.2, resolving dependency issues by JackUrb in https://github.com/facebookresearch/Mephisto/pull/898
* Upgrade yarn 3.2.1->3.2.4 by pringshia in https://github.com/facebookresearch/Mephisto/pull/920

New Contributors
* chiehminwei made their first contribution in https://github.com/facebookresearch/Mephisto/pull/861
* mjkanji made their first contribution in https://github.com/facebookresearch/Mephisto/pull/917

**Full Changelog**: https://github.com/facebookresearch/Mephisto/compare/v1.0.3...v1.1.0

Overview

`v1.0.2` shipped with a bug that broke ParlAI-chat related tasks. This release only includes the fix for that (859), but is otherwise equivalent to [`v1.0.2`](https://github.com/facebookresearch/Mephisto/releases/tag/v1.0.2).

Overview

Some issues still remaining from `v1.0.0` (and even sooner) have been ironed out, so this release aims to fix those as well as include some new QoL upgrades.

Highlights
- A status mismatch issue related to collection slowdowns on long-running tasks has been squashed (830)
- Adding testing for our example files (795, 800)
- Upgrading completely to Poetry as our package manager (779)
- Core work for new worker addons package, to be included in coming release notes (791, 785)

Additional Changes
- MTurk improvements and fixes:
- 810: Functionality to specify the lifetime of a task
- 780: Fix to HIT tags that were being improperly submitted as individual characters
- 767: Fix to storing and restoring AWS credentials
- Bugfix for deploying to the `HerokuArchitect` via git (824)
- Locking down the version of Node that our router uses to solve issues deploying on the `EC2Architect` (762)
- Cleanup to the `Operator.shutdown` method to allow disconnected onboardings to be cleared (769)
- Developer QoL:
- 814: Consolidating the `AgentState` classes and introducing a `metadata` attribute
- 770: Making `Agent` and `OnboardingAgent` pull from the same base class for code deduplication
- Bugfixes to the `RemoteProcedureBlueprint`:
- 763: Fixing an issue that prevented reloading from restoring the state
- 798, 782: Cleaning up on the `RemoteProcedure` examples
- 784: Adding a new `RemoteProcedure` example using a text model-in-the-loop

Overview

Following the 1.0.0 release, a few bugs were surfaced. The largest involved an update of `mephisto-task` already published, and this release syncs the underlying Mephisto library to refer to the same version.

Full Changelog

- 728 Fixes an issue preventing live tasks from working over https
- 749 Adds back some missing `mephisto-task` package versions that were preventing correct builds at runtime
- 756 Fixes a small bug in the `HTMLStaticBlueprint`
- 745 Clarifying correct typing for data passed via `handleSubmit` in our `StaticBlueprint` tasks
- 754 fixes docker imaging issue if `mephisto metrics install` has already been run locally
- 747 Set some defaults for `max_num_concurrent_tasks` to encourage people to use this option more consistently

This PR captures all of the work the team has done for Mephisto up to now, setting our first stable API, prioritizing user-friendly features, and providing a massively [updated documentation site](https://mephisto.ai/). Read more about this release [on the blog](https://mephisto.ai/blog/mephisto-1.0).

Overall this update doesn't change any existing semantics for Mephisto, but includes some new functionality (including launches on EC2 instead of Heroku!) and some small bugfixes. In total, this release contains the following:
- EC2 architect and followup fixes (603, 606, 609, 618, 622)
- Documentation overhaul (611, 612, 613)
- Early implementation for using Gold labelling worker quality control (585)
- Bugfixes for existing blueprints (588, 594, 637)
- Various lint and dependency updates