Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[CoreEngine] refactor section names in the job yaml file and update related codes. #1210

Merged
merged 1 commit into from
Aug 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion python/fedml/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
_global_training_type = None
_global_comm_backend = None

__version__ = "0.8.8a14"
__version__ = "0.8.8a15"


def init(args=None):
Expand Down
12 changes: 6 additions & 6 deletions python/fedml/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,19 +165,19 @@ fedml_arguments:

# Local directory where your source code resides.
# If your job doesn't contain any source code, it can be empty.
Workspace: hello_world
workspace: hello_world

# Running entry commands which will be executed as the job entry point.
# Support multiple lines, which can not be empty.
Job: |
job: |
echo "Hello, Here is the Falcon platform."
echo "Current directory is as follows."
pwd
python hello_world.py

# Bootstrap shell commands which will be executed before running entry commands.
# Support multiple lines, which can be empty.
Bootstrap: |
bootstrap: |
pip install -r requirements.txt
echo "Bootstrap finished."

Expand All @@ -188,11 +188,11 @@ computing:

You just need to customize the following config items.

1. `Workspace`, It is the local directory where your source code resides.
1. `workspace`, It is the local directory where your source code resides.

2. `Job`, It is the running entry command which will be executed as the job entry point.
2. `job`, It is the running entry command which will be executed as the job entry point.

3. `Bootstrap`, It is the bootstrap shell command which will be executed before running entry commands.
3. `bootstrap`, It is the bootstrap shell command which will be executed before running entry commands.

Then you can use the following example CLI to launch the job at the MLOps platform.
(Replace $YourApiKey with your own account API key from open.fedml.ai)
Expand Down
2 changes: 1 addition & 1 deletion python/fedml/cli/edge_deployment/client_runner.py
Original file line number Diff line number Diff line change
Expand Up @@ -490,7 +490,7 @@ def execute_job_task(self, entry_file_full_path, conf_file_full_path, dynamic_ar
if expert_mode is None:
executable_interpreter = ClientConstants.CLIENT_SHELL_PS \
if platform.system() == ClientConstants.PLATFORM_WINDOWS else ClientConstants.CLIENT_SHELL_BASH
executable_commands = job_yaml.get("Job", "")
executable_commands = job_yaml.get("job", "")
else:
using_easy_mode = False
executable_interpreter = expert_mode.get("executable_interpreter", "")
Expand Down
12 changes: 6 additions & 6 deletions python/fedml/cli/scheduler/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,19 @@ fedml_arguments:

# Local directory where your source code resides.
# If your job doesn't contain any source code, it can be empty.
Workspace: hello_world
workspace: hello_world

# Running entry commands which will be executed as the job entry point.
# Support multiple lines, which can not be empty.
Job: |
job: |
echo "Hello, Here is the Falcon platform."
echo "Current directory is as follows."
pwd
python hello_world.py

# Bootstrap shell commands which will be executed before running entry commands.
# Support multiple lines, which can be empty.
Bootstrap: |
bootstrap: |
pip install -r requirements.txt
echo "Bootstrap finished."

Expand All @@ -44,11 +44,11 @@ computing:

You just need to customize the following config items.

1. `Workspace`, It is the local directory where your source code resides.
1. `workspace`, It is the local directory where your source code resides.

2. `Job`, It is the running entry command which will be executed as the job entry point.
2. `job`, It is the running entry command which will be executed as the job entry point.

3. `Bootstrap`, It is the bootstrap shell command which will be executed before running entry commands.
3. `bootstrap`, It is the bootstrap shell command which will be executed before running entry commands.

Then you can use the following example CLI to launch the job at the MLOps platform.
(Replace $YourApiKey with your own account API key from open.fedml.ai)
Expand Down
8 changes: 4 additions & 4 deletions python/fedml/cli/scheduler/call_gpu.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,22 @@ fedml_arguments:

# Local directory where your source code resides.
# If your job doesn't contain any source code, it can be empty.
Workspace: hello_world
workspace: hello_world

# Running entry commands which will be executed as the job entry point.
# Support multiple lines, which can not be empty.
Job: |
job: |
echo "Hello, Here is the Falcon platform."
echo "Current directory is as follows."
pwd
python hello_world.py

# Bootstrap shell commands which will be executed before running entry commands.
# Support multiple lines, which can be empty.
Bootstrap: |
bootstrap: |
pip install -r requirements.txt
echo "Bootstrap finished."

computing:
minimum_num_gpus: 1 # minimum # of GPUs to provision
minimum_num_gpus: 1 # minimum # of GPUs to provision
maximum_cost_per_hour: $1.75 # max cost per hour for your job per machine
6 changes: 3 additions & 3 deletions python/fedml/cli/scheduler/launch_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -390,9 +390,9 @@ def __init__(self, job_yaml_file):
self.base_dir = os.path.dirname(job_yaml_file)
self.using_easy_mode = True
self.executable_interpreter = "bash"
self.executable_file_folder = self.job_config_dict.get("Workspace", None)
self.executable_commands = self.job_config_dict.get("Job", "")
self.bootstrap = self.job_config_dict.get("Bootstrap", None)
self.executable_file_folder = self.job_config_dict.get("workspace", None)
self.executable_commands = self.job_config_dict.get("job", "")
self.bootstrap = self.job_config_dict.get("bootstrap", None)
self.executable_file = None
self.executable_conf_option = ""
self.executable_conf_file_folder = None
Expand Down
2 changes: 1 addition & 1 deletion python/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ def finalize_options(self):

setup(
name="fedml",
version="0.8.8a14",
version="0.8.8a15",
author="FedML Team",
author_email="[email protected]",
description="A research and production integrated edge-cloud library for "
Expand Down