seismometer.configuration.model.OtherInfo

pydantic model seismometer.configuration.model.OtherInfo

Locations of configuration and data files.

Show Entity Relationship Diagram
digraph "Entity Relationship Diagram created by erdantic" { graph [fontcolor=gray66, fontname="Times New Roman,Times,Liberation Serif,serif", fontsize=9, nodesep=0.5, rankdir=LR, ranksep=1.5 ]; node [fontname="Times New Roman,Times,Liberation Serif,serif", fontsize=14, label="\N", shape=plain ]; edge [dir=both]; "seismometer.configuration.model.OtherInfo" [label=<<table border="0" cellborder="1" cellspacing="0"><tr><td port="_root" colspan="2"><b>OtherInfo</b></td></tr><tr><td>template</td><td port="template">Optional[str]</td></tr><tr><td>info_dir</td><td port="info_dir">Optional[Union[str, Path]]</td></tr><tr><td>event_definition</td><td port="event_definition">Optional[Union[str, Path]]</td></tr><tr><td>prediction_definition</td><td port="prediction_definition">Optional[Union[str, Path]]</td></tr><tr><td>usage_config</td><td port="usage_config">Optional[Union[str, Path]]</td></tr><tr><td>automation_config</td><td port="automation_config">Optional[Union[str, Path]]</td></tr><tr><td>data_dir</td><td port="data_dir">Optional[Union[str, Path]]</td></tr><tr><td>prediction_path</td><td port="prediction_path">str | Path</td></tr><tr><td>event_path</td><td port="event_path">str | Path</td></tr><tr><td>metadata_path</td><td port="metadata_path">str | Path</td></tr></table>>, tooltip="seismometer.configuration.model.OtherInfo&#xA;&#xA;Locations of configuration and data files.&#xA;"]; }

Show JSON schema
{
   "title": "OtherInfo",
   "description": "Locations of configuration and data files.",
   "type": "object",
   "properties": {
      "template": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Template"
      },
      "info_dir": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "format": "path",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Info Dir"
      },
      "event_definition": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "format": "path",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Event Definition"
      },
      "prediction_definition": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "format": "path",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Prediction Definition"
      },
      "usage_config": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "format": "path",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Usage Config"
      },
      "automation_config": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "format": "path",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Automation Config"
      },
      "data_dir": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "format": "path",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Data Dir"
      },
      "prediction_path": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "format": "path",
               "type": "string"
            }
         ],
         "default": "scores.parquet",
         "title": "Prediction Path"
      },
      "event_path": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "format": "path",
               "type": "string"
            }
         ],
         "default": "events.parquet",
         "title": "Event Path"
      },
      "metadata_path": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "format": "path",
               "type": "string"
            }
         ],
         "default": "metadata.json",
         "title": "Metadata Path"
      }
   }
}

Fields:
field automation_config: str | Path | None = None

The location of the automation configuration; used during run if automated metric export is desired.

field data_dir: str | Path | None = None

The parent location of data files; primarily used during run.

field event_definition: str | Path | None = None

The location of the event dictionary.

field event_path: str | Path = 'events.parquet'

The location of the event data within data_dir.

field info_dir: str | Path | None = None

Writable directors for output; used during run.

field metadata_path: str | Path = 'metadata.json'

The location of the metadata file within data_dir.

field prediction_definition: str | Path | None = None

The location of the prediction dictionary.

field prediction_path: str | Path = 'scores.parquet'

The location of the prediction data within data_dir.

field template: str | None = None

Descriptor of the template; not used.

field usage_config: str | Path | None = None

The location of the usage configuration; used during run.