-
Notifications
You must be signed in to change notification settings - Fork 77
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactor a lot of paths to re-organize structure (#295)
* moving around the stuff from data_model and webapp/client * Migrating crowd providers * Moving script utils * Migrating architects * Forgot to update channel callsites * Moving blueprints * Migrating core * merging 298 * doc path refactor
- Loading branch information
Showing
277 changed files
with
33,504 additions
and
11,689 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| #!/usr/bin/env python3 | ||
|
|
||
| # Copyright (c) Facebook, Inc. 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. | ||
|
|
||
| from abc import ABC, abstractmethod | ||
| from dataclasses import dataclass, field | ||
| from omegaconf import MISSING, DictConfig | ||
| from typing import Dict, List, Any, ClassVar, Type, TYPE_CHECKING, Callable | ||
|
|
||
| if TYPE_CHECKING: | ||
| from mephisto.abstractions.channel import Channel | ||
| from mephsito.data_model.packet import Packet | ||
| from mephisto.data_model.task_run import TaskRun | ||
| from mephisto.abstractions.database import MephistoDB | ||
| from mephisto.abstractions.blueprint import SharedTaskState | ||
| from argparse import _ArgumentGroup as ArgumentGroup | ||
|
|
||
|
|
||
| @dataclass | ||
| class ArchitectArgs: | ||
| """Base class for arguments to configure architects""" | ||
|
|
||
| _architect_type: str = MISSING | ||
|
|
||
|
|
||
| class Architect(ABC): | ||
| """ | ||
| Provides methods for setting up a server somewhere and deploying tasks | ||
| onto that server. | ||
| """ | ||
|
|
||
| ArgsClass: ClassVar[Type[ArchitectArgs]] = ArchitectArgs | ||
| ARCHITECT_TYPE: str | ||
|
|
||
| def __init__( | ||
| self, | ||
| db: "MephistoDB", | ||
| args: DictConfig, | ||
| shared_state: "SharedTaskState", | ||
| task_run: "TaskRun", | ||
| build_dir_root: str, | ||
| ): | ||
| """ | ||
| Initialize this architect with whatever options are provided given | ||
| ArgsClass. Parse whatever additional options may be required | ||
| for the specific task_run. | ||
| Also set up any required database/memory into the MephistoDB so that | ||
| this data can be stored long-term. | ||
| """ | ||
| raise NotImplementedError() | ||
|
|
||
| @classmethod | ||
| def assert_task_args(cls, args: DictConfig, shared_state: "SharedTaskState"): | ||
| """ | ||
| Assert that the provided arguments are valid. Should | ||
| fail if a task launched with these arguments would | ||
| not work. | ||
| This should include throwing an exception if the architect | ||
| needs login details or something similar given the | ||
| arguments passed in. | ||
| """ | ||
| return | ||
|
|
||
| def get_channels( | ||
| self, | ||
| on_channel_open: Callable[[str], None], | ||
| on_catastrophic_disconnect: Callable[[str], None], | ||
| on_message: Callable[[str, "Packet"], None], | ||
| ) -> List["Channel"]: | ||
| """ | ||
| Return a list of all relevant channels that the Supervisor will | ||
| need to register to in order to function | ||
| """ | ||
| raise NotImplementedError() | ||
|
|
||
| def download_file(self, filename: str, save_dir: str) -> None: | ||
| """ | ||
| Save the file that is noted as stored on the server to | ||
| the desired save location. | ||
| """ | ||
| raise NotImplementedError() | ||
|
|
||
| def prepare(self) -> str: | ||
| """ | ||
| Produce the server files that will be deployed to the server | ||
| """ | ||
| raise NotImplementedError() | ||
|
|
||
| def deploy(self) -> str: | ||
| """ | ||
| Launch the server, and push the task files to the server. Return | ||
| the server URL | ||
| """ | ||
| raise NotImplementedError() | ||
|
|
||
| def cleanup(self) -> None: | ||
| """ | ||
| Remove any files that were used for the deployment process that | ||
| no longer need to be kept track of now that the task has | ||
| been launched. | ||
| """ | ||
| raise NotImplementedError() | ||
|
|
||
| def shutdown(self) -> None: | ||
| """ | ||
| Shut down the server launched by this Surveyor, as stored | ||
| in the db. | ||
| """ | ||
| raise NotImplementedError() |
File renamed without changes.
File renamed without changes.
File renamed without changes.
Oops, something went wrong.