RGBClassTransformerConfig#
Note
All Configs are derived from rastervision.pipeline.config.Config
, which itself is a pydantic Model.
- pydantic model RGBClassTransformerConfig[source]#
Configure a
RGBClassTransformer
.Show JSON schema
{ "title": "RGBClassTransformerConfig", "description": "Configure a :class:`.RGBClassTransformer`.", "type": "object", "properties": { "type_hint": { "title": "Type Hint", "default": "rgb_class_transformer", "enum": [ "rgb_class_transformer" ], "type": "string" }, "class_config": { "title": "Class Config", "description": "The class config defining the mapping between classes and colors.", "allOf": [ { "$ref": "#/definitions/ClassConfig" } ] } }, "required": [ "class_config" ], "additionalProperties": false, "definitions": { "ClassConfig": { "title": "ClassConfig", "description": "Configure class information for a machine learning task.", "type": "object", "properties": { "names": { "title": "Names", "description": "Names of classes. The i-th class in this list will have class ID = i.", "type": "array", "items": { "type": "string" } }, "colors": { "title": "Colors", "description": "Colors used to visualize classes. Can be color strings accepted by matplotlib or RGB tuples. If None, a random color will be auto-generated for each class.", "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "array", "items": {} } ] } }, "null_class": { "title": "Null Class", "description": "Optional name of class in `names` to use as the null class. This is used in semantic segmentation to represent the label for imagery pixels that are NODATA or that are missing a label. If None and the class names include \"null\", it will automatically be used as the null class. If None, and this Config is part of a SemanticSegmentationConfig, a null class will be added automatically.", "type": "string" }, "type_hint": { "title": "Type Hint", "default": "class_config", "enum": [ "class_config" ], "type": "string" } }, "required": [ "names" ], "additionalProperties": false } } }
- Config
extra: str = forbid
validate_assignment: bool = True
- Fields
- field class_config: ClassConfig [Required]#
The class config defining the mapping between classes and colors.
- build() RGBClassTransformer [source]#
Build an instance of the corresponding type of object using this config.
For example, BackendConfig will build a Backend object. The arguments to this method will vary depending on the type of Config.
- Return type
- recursive_validate_config()#
Recursively validate hierarchies of Configs.
This uses reflection to call validate_config on a hierarchy of Configs using a depth-first pre-order traversal.
- revalidate()#
Re-validate an instantiated Config.
Runs all Pydantic validators plus self.validate_config().
Adapted from: https://github.com/samuelcolvin/pydantic/issues/1864#issuecomment-679044432
- update(pipeline=None, scene=None)#
Update any fields before validation.
Subclasses should override this to provide complex default behavior, for example, setting default values as a function of the values of other fields. The arguments to this method will vary depending on the type of Config.
- update_root(root_dir)#
- validate_config()#
Validate fields that should be checked after update is called.
This is to complement the builtin validation that Pydantic performs at the time of object construction.