Merge pull request #1058 from facebookresearch/make-task-review-server

Create reusable React app for task results review

.github/workflows/cypress-end-to-end-tests.yml

@@ -7,6 +7,8 @@ on:
     branches: [main]
     paths-ignore:
       - "**.md"
+env:
+  HYDRA_FULL_ERROR: 1
 jobs:
   # This job is made to setup path filtering, learn more about it here: https://github.com/facebookresearch/Mephisto/pull/857
   changes:
@@ -273,7 +275,9 @@ jobs:
           node-version: 16.16.0
 
       - name: 🤖 Install Mephisto
-        run: pip install -e .
+        run: |
+          pip install -e .
+          pip install detoxify
 
       - name: 🖋 Create data directory
         run: mkdir -p ~/mephisto/data

.gitignore

@@ -55,3 +55,6 @@ aws_credentials
 docker-compose.local.*
 env.local
 my-review-interface
+docker/entrypoints/*.sh
+!docker/entrypoints/server.mturk.sh
+!docker/entrypoints/server.prolific.sh

README.md

@@ -23,6 +23,8 @@ You can find complete details about the project on our [docs website](https://me
 
 [Get started in 10 minutes](https://mephisto.ai/docs/guides/quickstart)
 
+[How to run projects](mephisto/README.md)
+
 ## Want to help?
 
 Check out our [guidelines for contributing](https://github.com/facebookresearch/Mephisto/blob/main/CONTRIBUTING.md) and then take a look at some of our tagged issues: [good first issue](https://github.com/facebookresearch/Mephisto/labels/good%20first%20issue), [help wanted](https://github.com/facebookresearch/Mephisto/labels/help%20wanted).

docker/docker-compose.dev.vscode.yml

@@ -5,8 +5,8 @@
 version: "3"
 
 services:
-  fb_mephisto_vscode:
-    container_name: fb_mephisto_vscode
+  mephisto_dc_vscode:
+    container_name: mephisto_dc_vscode
     build:
       context: ..
       dockerfile: Dockerfile

docker/docker-compose.dev.yml

@@ -5,8 +5,8 @@
 version: "3"
 
 services:
-  fb_mephisto:
-    container_name: fb_mephisto
+  mephisto_dc:
+    container_name: mephisto_dc
     build:
       context: ..
       dockerfile: Dockerfile

examples/parlai_chat_task_demo/hydra_configs/conf/base.yaml

@@ -1,8 +1,9 @@
+#@package _global_
+
 # Copyright (c) Meta Platforms and its affiliates.
 # This source code is licensed under the MIT license found in the
 # LICENSE file in the root directory of this source tree.
 
-#@package _global_
 defaults:
   - /mephisto/blueprint: parlai_chat
   - /mephisto/architect: local

examples/parlai_chat_task_demo/hydra_configs/conf/custom_prebuilt.yaml

@@ -1,8 +1,9 @@
+#@package _global_
+
 # Copyright (c) Meta Platforms and its affiliates.
 # This source code is licensed under the MIT license found in the
 # LICENSE file in the root directory of this source tree.
 
-#@package _global_
 defaults:
   - base
 mephisto:

examples/parlai_chat_task_demo/hydra_configs/conf/custom_simple.yaml

@@ -1,8 +1,9 @@
+#@package _global_
+
 # Copyright (c) Meta Platforms and its affiliates.
 # This source code is licensed under the MIT license found in the
 # LICENSE file in the root directory of this source tree.
 
-#@package _global_
 defaults:
   - base
 mephisto:

examples/parlai_chat_task_demo/hydra_configs/conf/example.yaml

@@ -1,8 +1,9 @@
+#@package _global_
+
 # Copyright (c) Meta Platforms and its affiliates.
 # This source code is licensed under the MIT license found in the
 # LICENSE file in the root directory of this source tree.
 
-#@package _global_
 defaults:
   - base
 mephisto:

examples/parlai_chat_task_demo/hydra_configs/conf/onboarding_example.yaml

@@ -1,8 +1,9 @@
+#@package _global_
+
 # Copyright (c) Meta Platforms and its affiliates.
 # This source code is licensed under the MIT license found in the
 # LICENSE file in the root directory of this source tree.
 
-#@package _global_
 defaults:
   - base
 mephisto:

examples/remote_procedure/mnist/README.md

@@ -1,11 +1,9 @@
-<!---
-  Copyright (c) Meta Platforms and its affiliates.
-  This source code is licensed under the MIT license found in the
-  LICENSE file in the root directory of this source tree.
--->
-
 # Mephisto MNIST Model Evaluator demo
 
 This task is a simple model evaluation demo, presenting the worker with three spaces to draw images in, running an MNIST model on them to predict an output, and then allowing the worker to assess and correct that output.
 
-Introduced in [#677](https://github.com/facebookresearch/Mephisto/pull/677), some screenshots and discussion there.
+Introduced in [#677](https://github.com/facebookresearch/Mephisto/pull/677), some screenshots and discussion there.
+
+For more details how to write your own `webapp` (ReactJS application) see example in current directory. 
+Also, read [short documentation](../../../mephisto/client/review_app/README.md) 
+for the main Review App to understand how to add review part in your `webapp`.