Skip to content

Refactor Scheduler schema definitions to make it easier to add new ones. #979

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
May 20, 2025
Merged

Refactor Scheduler schema definitions to make it easier to add new ones. #979

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b66e17a
Refactor Scheduler schema definitions to make it easier to add new ones.
bpkroth May 19, 2025
7563b8a
fixup
bpkroth May 19, 2025
957892c
Merge branch 'main' into refactor/scheduler-schemas
motus May 19, 2025
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
69 changes: 69 additions & 0 deletions mlos_bench/mlos_bench/config/schemas/schedulers/base-scheduler-subschema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/microsoft/MLOS/main/mlos_bench/mlos_bench/config/schemas/schedulers/base-scheduler-subschema.json",
"title": "mlos_bench base Scheduler config schema definitions",
"description": "mlos_bench base Scheduler config schema definitions for all Scheduler types.",

"$defs": {
"base_scheduler_config": {
"$comment": "config properties common to all Scheduler types.",
"description": "The scheduler-specific config.",
"type": "object",
"minProperties": 1,
"properties": {
"experiment_id": {
"$ref": "../cli/common-defs-subschemas.json#/$defs/experiment_id"
},
"trial_id": {
"$ref": "../cli/common-defs-subschemas.json#/$defs/trial_id"
},
"config_id": {
"$ref": "../cli/common-defs-subschemas.json#/$defs/config_id"
},
"teardown": {
"description": "Whether to teardown the experiment after running it.",
"type": "boolean"
},
"max_trials": {
"description": "Max. number of trials to run. Use -1 or 0 for unlimited.",
"type": "integer",
"minimum": -1,
"examples": [50, -1]
},
"trial_config_repeat_count": {
"description": "Number of times to repeat a config.",
"type": "integer",
"minimum": 1,
"examples": [3, 5]
}
}
}
},

"type": "object",
"properties": {
"$schema": {
"description": "The schema to use for validating the scheduler config (accepts both URLs and local paths).",
"type": "string",
"$comment": "This is optional, but if provided, should match the name of the root schema file.",
"pattern": "/schemas/schedulers/scheduler-schema.json$"
},

"description": {
"description": "Optional description of the config.",
"type": "string"
},

"class": {
"description": "The name of the scheduler class to use.",
"type": "string",
"$comment": "Exact matches are handled elsewhere.",
"pattern": "^mlos_bench[.]schedulers[.]"
},

"config": {
"$ref": "#/$defs/base_scheduler_config"
}
},
"required": ["class"]
}
104 changes: 11 additions & 93 deletions mlos_bench/mlos_bench/config/schemas/schedulers/scheduler-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,105 +2,23 @@
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/microsoft/MLOS/main/mlos_bench/mlos_bench/config/schemas/schedulers/scheduler-schema.json",
"title": "mlos_bench Scheduler config",

"$defs": {
"comment": {
"$comment": "This section contains reusable partial schema bits (or just split out for readability)"
},

"config_base_scheduler": {
"$comment": "config properties common to all Scheduler types.",
"type": "object",
"properties": {
"experiment_id": {
"$ref": "../cli/common-defs-subschemas.json#/$defs/experiment_id"
},
"trial_id": {
"$ref": "../cli/common-defs-subschemas.json#/$defs/trial_id"
},
"config_id": {
"$ref": "../cli/common-defs-subschemas.json#/$defs/config_id"
},
"teardown": {
"description": "Whether to teardown the experiment after running it.",
"type": "boolean"
},
"max_trials": {
"description": "Max. number of trials to run. Use -1 or 0 for unlimited.",
"type": "integer",
"minimum": -1,
"examples": [50, -1]
},
"trial_config_repeat_count": {
"description": "Number of times to repeat a config.",
"type": "integer",
"minimum": 1,
"examples": [3, 5]
}
}
}
},

"description": "config for the mlos_bench scheduler",
"$comment": "top level schema document rules",
"type": "object",
"properties": {
"$schema": {
"description": "The schema to use for validating the scheduler config (accepts both URLs and local paths).",
"type": "string",
"$comment": "This is optional, but if provided, should match the name of this file.",
"pattern": "/schemas/schedulers/scheduler-schema.json$"
},

"description": {
"description": "Optional description of the config.",
"type": "string"
},

"class": {
"description": "The name of the scheduler class to use.",
"$comment": "required",
"enum": [
"mlos_bench.schedulers.SyncScheduler",
"mlos_bench.schedulers.sync_scheduler.SyncScheduler"
]
"type": "object",
"allOf": [
{
"$comment": "All scheduler subschemas support these base properties.",
"$ref": "./base-scheduler-subschema.json"
},

"config": {
"description": "The scheduler-specific config.",
"$comment": "Stub for scheduler-specific config appended with condition statements below",
"type": "object",
"minProperties": 1
}
},
"required": ["class"],

"oneOf": [
{
"$comment": "extensions to the 'config' object properties when synchronous scheduler is being used",
"if": {
"properties": {
"class": {
"enum": [
"mlos_bench.schedulers.SyncScheduler",
"mlos_bench.schedulers.sync_scheduler.SyncScheduler"
]
}
},
"required": ["class"]
},
"then": {
"properties": {
"config": {
"type": "object",
"allOf": [{ "$ref": "#/$defs/config_base_scheduler" }],
"$comment": "disallow other properties",
"unevaluatedProperties": false
}
"$comment": "The set of known Scheduler subschemas. Add others as needed.",
"oneOf": [
{
"$ref": "./sync-scheduler-subschema.json"
}
},
"else": false
]
}
],
"unevaluatedProperties": false
"required": ["class"]
}
27 changes: 27 additions & 0 deletions mlos_bench/mlos_bench/config/schemas/schedulers/sync-scheduler-subschema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/microsoft/MLOS/main/mlos_bench/mlos_bench/config/schemas/schedulers/sync-scheduler-subschema.json",
"title": "mlos_bench SyncScheduler config",
"description": "config for an mlos_bench SyncScheduler",
"type": "object",
"properties": {
"class": {
"enum": [
"mlos_bench.schedulers.SyncScheduler",
"mlos_bench.schedulers.sync_scheduler.SyncScheduler"
]
},
"config": {
"type": "object",
"$comment": "No extra properties supported by SyncScheduler.",
"allOf": [
{
"$ref": "base-scheduler-subschema.json#/$defs/base_scheduler_config"
}
],
"minProperties": 1,
"unevaluatedProperties": false
}
},
"required": ["class"]
}
Loading