EvaluatorConfiguration

pydantic model ansys.hps.client.rms.EvaluatorConfiguration

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Show JSON schema

{
   "title": "EvaluatorConfiguration",
   "type": "object",
   "properties": {
      "id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Unique database ID (read-only).",
         "title": "Id"
      },
      "evaluator_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "ID of the parent evaluator (read-only).",
         "title": "Evaluator Id"
      },
      "last_modified": {
         "anyOf": [
            {
               "format": "date-time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Last modified time.",
         "title": "Last Modified"
      },
      "working_directory": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Working Directory"
      },
      "local_file_cache_max_size": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Maximum allowed cache size in bytes.",
         "title": "Local File Cache Max Size"
      },
      "max_num_parallel_tasks": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Max Num Parallel Tasks"
      },
      "task_directory_cleanup": {
         "anyOf": [
            {
               "$ref": "#/$defs/TaskDirectoryCleanupEnum"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Task Directory Cleanup"
      },
      "resources": {
         "anyOf": [
            {
               "$ref": "#/$defs/EvaluatorResources"
            },
            {
               "type": "null"
            }
         ],
         "default": {
            "custom": {}
         }
      },
      "task_manager_type": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Task Manager Type"
      },
      "loop_interval": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 5,
         "description": "Number of seconds between each iteration of the evaluator's main loop.",
         "title": "Loop Interval"
      },
      "local_file_cache": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": true,
         "description": "Whether to configure a local file cache in the file tool.",
         "title": "Local File Cache"
      },
      "applications": {
         "anyOf": [
            {
               "items": {
                  "$ref": "#/$defs/ApplicationInfo"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": [],
         "description": "List of available applications.",
         "title": "Applications"
      },
      "project_server_select": {
         "anyOf": [
            {
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": true,
         "description": "Whether to get project assignments from the server instead of using the locally set values.",
         "title": "Project Server Select"
      },
      "project_list": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": [],
         "description": "IDs of projects that the evaluator should work on, in order.",
         "title": "Project List"
      },
      "project_assignment_mode": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": "all_active",
         "description": "How the evaluator selects projects to work on. Options are: disabled, all_active, list.",
         "title": "Project Assignment Mode"
      },
      "context": {
         "anyOf": [
            {
               "$ref": "#/$defs/Context"
            },
            {
               "type": "null"
            }
         ],
         "default": {
            "custom": {},
            "use_local_scratch": false
         },
         "description": "Runtime properties to pass to executed tasks."
      }
   },
   "$defs": {
      "ApplicationInfo": {
         "properties": {
            "name": {
               "description": "Application name.",
               "title": "Name",
               "type": "string"
            },
            "version": {
               "description": "Application version.",
               "title": "Version",
               "type": "string"
            },
            "install_path": {
               "description": "Installation path of the application.",
               "title": "Install Path",
               "type": "string"
            },
            "executable": {
               "description": "Executable path to run the application.",
               "title": "Executable",
               "type": "string"
            },
            "environment": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Environment setup for the process.",
               "title": "Environment"
            },
            "capabilities": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Capabilities of the application.",
               "title": "Capabilities"
            },
            "customization_hook": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Custom hook dictionary for modifying the configuration before performing runs.",
               "title": "Customization Hook"
            }
         },
         "required": [
            "name",
            "version",
            "install_path",
            "executable"
         ],
         "title": "ApplicationInfo",
         "type": "object"
      },
      "Context": {
         "properties": {
            "custom": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "anyOf": [
                           {
                              "type": "integer"
                           },
                           {
                              "type": "boolean"
                           },
                           {
                              "type": "string"
                           },
                           {
                              "type": "number"
                           },
                           {
                              "type": "null"
                           }
                        ]
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": {},
               "description": "Custom runtime properties.",
               "title": "Custom"
            },
            "machines_list": {
               "anyOf": [
                  {
                     "items": {
                        "$ref": "#/$defs/Machine"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "List of machines for distributed parallel processing.",
               "title": "Machines List"
            },
            "use_local_scratch": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": false,
               "description": "Whether to use local storage as the working directory for jobs.",
               "title": "Use Local Scratch"
            }
         },
         "title": "Context",
         "type": "object"
      },
      "EvaluatorResources": {
         "properties": {
            "num_cores": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Number of cores.",
               "title": "Num Cores"
            },
            "platform": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/PlatformEnum"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Basic platform information. Options are ``'linux'`` and ``'windows'``."
            },
            "memory": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Amount of RAM in bytes.",
               "title": "Memory"
            },
            "disk_space": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Amount of disk space in bytes.",
               "title": "Disk Space"
            },
            "custom": {
               "anyOf": [
                  {
                     "additionalProperties": {
                        "anyOf": [
                           {
                              "type": "integer"
                           },
                           {
                              "type": "boolean"
                           },
                           {
                              "type": "string"
                           },
                           {
                              "type": "number"
                           },
                           {
                              "type": "null"
                           }
                        ]
                     },
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": {},
               "description": "Custom resource properties.",
               "title": "Custom"
            },
            "hpc_resources": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/HpcResources"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            }
         },
         "title": "EvaluatorResources",
         "type": "object"
      },
      "HpcResources": {
         "properties": {
            "num_cores_per_node": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Number of cores per node.",
               "title": "Num Cores Per Node"
            },
            "num_gpus_per_node": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Number of GPUs per node.",
               "title": "Num Gpus Per Node"
            },
            "exclusive": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Whether nodes are exclusive to a job. If ``False``, nodes are shared with other running jobs.",
               "title": "Exclusive"
            },
            "queue": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Scheduler's queue.",
               "title": "Queue"
            }
         },
         "title": "HpcResources",
         "type": "object"
      },
      "Machine": {
         "properties": {
            "name": {
               "description": "Name of the machine",
               "title": "Name",
               "type": "string"
            },
            "num_cores": {
               "description": "Number of cores available",
               "title": "Num Cores",
               "type": "integer"
            }
         },
         "required": [
            "name",
            "num_cores"
         ],
         "title": "Machine",
         "type": "object"
      },
      "PlatformEnum": {
         "enum": [
            "windows",
            "linux",
            "darwin"
         ],
         "title": "PlatformEnum",
         "type": "string"
      },
      "TaskDirectoryCleanupEnum": {
         "enum": [
            "always",
            "on_success",
            "never"
         ],
         "title": "TaskDirectoryCleanupEnum",
         "type": "string"
      }
   }
}

Fields:

• applications (List[ansys.hps.client.rms.models.ApplicationInfo] | None)

• context (ansys.hps.client.rms.models.Context | None)

• evaluator_id (str | None)

• id (str | None)

• last_modified (datetime.datetime | None)

• local_file_cache (bool | None)

• local_file_cache_max_size (int | None)

• loop_interval (float | None)

• max_num_parallel_tasks (int | None)

• project_assignment_mode (str | None)

• project_list (List[str] | None)

• project_server_select (bool | None)

• resources (ansys.hps.client.rms.models.EvaluatorResources | None)

• task_directory_cleanup (ansys.hps.client.rms.models.TaskDirectoryCleanupEnum | None)

• task_manager_type (str | None)

• working_directory (str | None)

field applications: Optional[List[ApplicationInfo]] = []

List of available applications.

field context: Optional[Context] = {'custom': {}, 'use_local_scratch': False}

Runtime properties to pass to executed tasks.

field evaluator_id: Optional[str] = None

ID of the parent evaluator (read-only).

field id: Optional[str] = None

Unique database ID (read-only).

field last_modified: Optional[datetime] = None

Last modified time.

field local_file_cache: Optional[bool] = True

Whether to configure a local file cache in the file tool.

field local_file_cache_max_size: Optional[int] = None

Maximum allowed cache size in bytes.

field loop_interval: Optional[float] = 5

Number of seconds between each iteration of the evaluator’s main loop.

field max_num_parallel_tasks: Optional[int] = None

field project_assignment_mode: Optional[str] = 'all_active'

How the evaluator selects projects to work on. Options are: disabled, all_active, list.

field project_list: Optional[List[str]] = []

IDs of projects that the evaluator should work on, in order.

field project_server_select: Optional[bool] = True

Whether to get project assignments from the server instead of using the locally set values.

field resources: Optional[EvaluatorResources] = {'custom': {}}

field task_directory_cleanup: Optional[TaskDirectoryCleanupEnum] = None

field task_manager_type: Optional[str] = None

field working_directory: Optional[str] = None