logml.analysis.config

class logml.analysis.config.PipelineItemConfig

Bases: pydantic.main.BaseModel

Analysis step configuration.

Show JSON schema

{
   "title": "PipelineItemConfig",
   "description": "Analysis step configuration.",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "description": "Step name defined by the author. This name can be used for cross-reference between different steps (for example to indicate that input data should be taken from an output of some other step). Also it works as a name for a subfolder on a disk which stores all the step-related data.",
         "type": "string"
      },
      "type": {
         "title": "Type",
         "description": "Analysis step type. Refer to :lml:ref:`Analysis Step Types` for details.",
         "type": "string"
      },
      "enable": {
         "title": "Enable",
         "default": true,
         "type": "boolean"
      },
      "params": {
         "title": "Params",
         "description": "Parameters for the analysis step. Refer to :lml:ref:`Analysis Step Types` for to understand structure required by a particular step.",
         "default": {},
         "type": "object"
      },
      "release_artifacts": {
         "title": "Release Artifacts",
         "description": "When set to True, artifacts produced by the step are published to the release folder.",
         "default": false,
         "type": "boolean"
      },
      "depends_on": {
         "title": "Depends On",
         "description": "List of items from which current item depends. Current item won't be executed untilall dependencies are successfully completed.",
         "default": [],
         "type": "array",
         "items": {
            "type": "string"
         }
      }
   },
   "required": [
      "name",
      "type"
   ]
}

Fields

depends_on (List[str])
enable (bool)
name (str)
params (dict)
release_artifacts (bool)
type (str)

field name: str [Required]: Step name defined by the author. This name can be used for cross-reference between different steps (for example to indicate that input data should be taken from an output of some other step). Also it works as a name for a subfolder on a disk which stores all the step-related data.

field type: str [Required]: Analysis step type. Refer to Analysis Step Types for details.

field enable: bool = True

field params: dict = {}: Parameters for the analysis step. Refer to Analysis Step Types for to understand structure required by a particular step.

field release_artifacts: bool = False: When set to True, artifacts produced by the step are published to the release folder.

field depends_on: List[str] = []: List of items from which current item depends. Current item won’t be executed untilall dependencies are successfully completed.

class logml.analysis.config.AnalysisPipelineConfig

Bases: pydantic.main.BaseModel

Analysis pipeline configuration.

Show JSON schema

{
   "title": "AnalysisPipelineConfig",
   "description": "Analysis pipeline configuration.",
   "type": "object",
   "properties": {
      "enable": {
         "title": "Enable",
         "default": true,
         "type": "boolean"
      },
      "items": {
         "title": "Items",
         "description": "List of analysis steps to perform.",
         "default": [],
         "type": "array",
         "items": {
            "$ref": "#/definitions/PipelineItemConfig"
         }
      }
   },
   "definitions": {
      "PipelineItemConfig": {
         "title": "PipelineItemConfig",
         "description": "Analysis step configuration.",
         "type": "object",
         "properties": {
            "name": {
               "title": "Name",
               "description": "Step name defined by the author. This name can be used for cross-reference between different steps (for example to indicate that input data should be taken from an output of some other step). Also it works as a name for a subfolder on a disk which stores all the step-related data.",
               "type": "string"
            },
            "type": {
               "title": "Type",
               "description": "Analysis step type. Refer to :lml:ref:`Analysis Step Types` for details.",
               "type": "string"
            },
            "enable": {
               "title": "Enable",
               "default": true,
               "type": "boolean"
            },
            "params": {
               "title": "Params",
               "description": "Parameters for the analysis step. Refer to :lml:ref:`Analysis Step Types` for to understand structure required by a particular step.",
               "default": {},
               "type": "object"
            },
            "release_artifacts": {
               "title": "Release Artifacts",
               "description": "When set to True, artifacts produced by the step are published to the release folder.",
               "default": false,
               "type": "boolean"
            },
            "depends_on": {
               "title": "Depends On",
               "description": "List of items from which current item depends. Current item won't be executed untilall dependencies are successfully completed.",
               "default": [],
               "type": "array",
               "items": {
                  "type": "string"
               }
            }
         },
         "required": [
            "name",
            "type"
         ]
      }
   }
}

Fields

enable (bool)
items (List[logml.analysis.config.PipelineItemConfig])

field enable: bool = True

field items: List[logml.analysis.config.PipelineItemConfig] = []: List of analysis steps to perform.

get_item_names(): Get list of enabled items.

get_items_by_type(type_name): Get items configuration.

get_item_by_name(name): Get items configuration.