Merge pull request #1092 from facebookresearch/v1.2-dev

Code for release v1.2

.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:
@@ -108,7 +110,7 @@ jobs:
           browser: chrome
           project: ./mephisto/abstractions/blueprints/static_html_task/source
           config-file: ./cypress.config.js
-          start: python ./examples/simple_static_task/static_test_script.py
+          start: python ./examples/simple_static_task/run_task.py
           wait-on: "http://localhost:3000/?worker_id=x&assignment_id=1"
           headless: true
 
@@ -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

@@ -25,9 +25,9 @@ mephisto/scripts/metrics/*
 
 # Examples
 examples/simple_static_task/hydra_configs/conf/*
-!examples/simple_static_task/hydra_configs/conf/example.yaml
+!examples/simple_static_task/hydra_configs/conf/example*.yaml
 !examples/simple_static_task/hydra_configs/conf/prolific_example.yaml
-!examples/simple_static_task/hydra_configs/conf/onboarding_example.yaml
+!examples/simple_static_task/hydra_configs/conf/onboarding_example*.yaml
 examples/**/build/*
 
 # PyCharm
@@ -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

CODE_OF_CONDUCT.md

@@ -1,3 +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.
+-->
+
 # Code of Conduct
 
 ## Our Pledge

CONTRIBUTING.md

@@ -1,3 +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.
+-->
+
 # Contributing to Mephisto
 We want to make contributing to this project as easy and transparent as
 possible.

Dockerfile

@@ -16,7 +16,7 @@ COPY . /mephisto
 RUN mkdir ~/.mephisto
 
 # Create the main Mephisto data directory
-RUN mkdir /mephisto/data
+RUN mkdir -p /mephisto/data
 
 # Write the mephisto config file manually for now to avoid prompt.
 # For bash-style string $ expansion for newlines,

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) Facebook, Inc. and its affiliates.
+Copyright (c) Meta Platforms and its affiliates.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,3 +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.
+-->
+
 <p align="center">
  <h1>
   <img width="250px" src="docs/web/static/img/logo.svg" alt="Mephisto" />
@@ -17,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

@@ -1,8 +1,12 @@
+# 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.
+
 version: "3"
 
 services:
-  fb_mephisto_vscode:
-    container_name: fb_mephisto_vscode
+  mephisto_dc_vscode:
+    container_name: mephisto_dc_vscode
     build:
       context: ..
       dockerfile: Dockerfile
@@ -26,6 +30,6 @@ services:
         /tmp/debugpy
         --wait-for-client
         --listen 0.0.0.0:5678
-        /mephisto/examples/simple_static_task/static_test_script.py
+        /mephisto/examples/simple_static_task/run_task.py
         ",
       ]

docker/docker-compose.dev.yml

@@ -1,8 +1,12 @@
+# 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.
+
 version: "3"
 
 services:
-  fb_mephisto:
-    container_name: fb_mephisto
+  mephisto_dc:
+    container_name: mephisto_dc
     build:
       context: ..
       dockerfile: Dockerfile

docker/entrypoints/server.mturk.sh

@@ -1,4 +1,9 @@
 #!/bin/sh
+
+# 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.
+
 set -e
 
 pip install pytest

docker/entrypoints/server.prolific.sh

@@ -1,4 +1,9 @@
 #!/bin/sh
+
+# 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.
+
 set -e
 
 pip install pytest black

docs/README.md

@@ -1,3 +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 Docs
 
 - Looking to get set-up and running quickly with Mephisto? Check out the **[10 minute quickstart](https://mephisto.ai/docs/guides/quickstart)**.

docs/legacy/hydra_migration.md

@@ -1,3 +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.
+-->
+
 # Transitioning from ARG_STRING to Hydra
 As Mephisto has moved away from the `ARG_STRING` in [#246](https://github.com/facebookresearch/Mephisto/pull/246), all existing scripts that used to use the `ARG_STRING` will need to use Hydra moving forward.
 

docs/storybook/README.md

@@ -1,3 +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.
+-->
+
 # Storybook
 
 This storybook houses UI components from the `@annotated/*` packages as well as other Mephisto front-end components.

docs/storybook/public/index.html

@@ -1,3 +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.
+-->
+
 <!DOCTYPE html>
 <html lang="en">
   <head>

docs/storybook/src/stories/GlobalContextStore.stories.jsx

@@ -1,3 +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.
+ */
+
 import React from "react";
 import Store, { useStore } from "global-context-store";
 

docs/storybook/src/stories/InterpolatedBBox.stories.jsx

@@ -1,3 +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.
+ */
+
 import React from "react";
 import Wrapper from "./Wrapper";
 

docs/storybook/src/stories/Keypoints.stories.jsx

@@ -1,3 +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.
+ */
+
 import React from "react";
 import Wrapper from "./Wrapper";
 import { Pose } from "@annotated/keypoint";

docs/storybook/src/stories/Layers.stories.jsx

@@ -1,3 +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.
+ */
+
 import React from "react";
 import Wrapper from "./Wrapper";
 import { AppShell, Layer } from "@annotated/shell";

docs/storybook/src/stories/Panels.stories.jsx

@@ -1,3 +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.
+ */
+
 import React from "react";
 import Wrapper from "./Wrapper";
 

docs/storybook/src/stories/VideoPlayer.stories.jsx

@@ -1,3 +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.
+ */
+
 import React from "react";
 import Wrapper from "./Wrapper";
 

docs/storybook/src/stories/Wrapper.jsx

@@ -1,3 +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.
+ */
+
 import React from "react";
 
 import "@annotated/shell/build/main.css";

docs/web/README.md

@@ -1,3 +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 Docs Website
 
 This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

docs/web/babel.config.js

@@ -1,3 +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.
+ */
+
 module.exports = {
   presets: [require.resolve("@docusaurus/core/lib/babel/preset")],
 };

docs/web/blog/2022-03-22-mephisto-1.0.md

@@ -1,3 +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.
+-->
+
 ---
 slug: mephisto-1.0
 title: Announcing Mephisto 1.0

docs/web/blog/authors.yml

@@ -1,3 +1,7 @@
+# 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.
+
 endi:
   name: Endilie Yacop Sucipto
   title: Maintainer of Docusaurus

docs/web/docs/explanations/architect_api.md

@@ -1,3 +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.
+-->
+
 # Architects, Routers, and `mephisto-task`: The Architect API.
 
 The Architect API is what allows Mephisto to completely abstract away the process of getting workers to operate in Mephisto tasks. In short, it aims to cover 4 primary functions:

docs/web/docs/explanations/architecture_overview.md

@@ -1,3 +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 Architecture
 
 This document seeks to explain the ideas that guided the creation of Mephisto. It will speak about the broad categories of how Mephisto works and how these parts are supposed to play together. It speaks a lot about the design goals of the Mephisto architecture. It isn't a perfect 1:1 representation of how the code is organized at the moment, but rather the ideal we were striving to reach. Understanding these ideals makes it _easier_ to understand Mephisto, both for usage and for joining in on development.

docs/web/docs/guides/how_to_contribute/_category_.yml

@@ -1,3 +1,7 @@
+# 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.
+
 label: "How to Contribute"
 collapsed: true
 position: 4

docs/web/docs/guides/how_to_contribute/backend_development.md

@@ -1,3 +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.
+-->
+
 ---
 sidebar_position: 3
 ---

docs/web/docs/guides/how_to_contribute/frontend_development.md

@@ -1,3 +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.
+-->
+
 ---
 sidebar_position: 2
 ---

docs/web/docs/guides/how_to_contribute/getting_started.md

@@ -1,3 +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.
+-->
+
 ---
 sidebar_position: 1
 ---

docs/web/docs/guides/how_to_use/_category_.yml

@@ -1,3 +1,7 @@
+# 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.
+
 label: "In-depth use"
 collapsed: true
 position: 3

docs/web/docs/guides/how_to_use/efficiency_organization/_category_.yml

@@ -1,3 +1,7 @@
+# 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.
+
 label: "Efficiency and Organization"
 collapsed: true
 position: 4

docs/web/docs/guides/how_to_use/efficiency_organization/config_faq.md

@@ -1,3 +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.
+-->
+
 # Common Configurations and FAQs
 
 This document contains some Mephisto usage patterns that should be fairly common, as well as usage tips and other know-how.