All Configs are derived from rastervision.pipeline.config.Config, which itself is a pydantic Model.

pydantic model STACItemCollectionConfig[source]#

Specify a raster via a STAC ItemCollection.

Show JSON schema
   "title": "STACItemCollectionConfig",
   "description": "Specify a raster via a STAC ItemCollection.",
   "type": "object",
   "properties": {
      "uri": {
         "title": "Uri",
         "description": "URI to a JSON-serialized STAC ItemCollection.",
         "type": "string"
      "assets": {
         "title": "Assets",
         "description": "Subset of assets to use. This should be a list of asset keys",
         "type": "array",
         "items": {
            "type": "string"
      "type_hint": {
         "title": "Type Hint",
         "default": "stac_item_collection",
         "enum": [
         "type": "string"
   "required": [
   "additionalProperties": false

  • extra: str = forbid

  • validate_assignment: bool = True

field assets: Optional[List[str]] = None#

Subset of assets to use. This should be a list of asset keys

field type_hint: Literal['stac_item_collection'] = 'stac_item_collection'#
field uri: str [Required]#

URI to a JSON-serialized STAC ItemCollection.

build() ItemCollection[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


classmethod deserialize(inp: str | dict | Config) Self#

Deserialize Config from a JSON file or dict, upgrading if possible.

If inp is already a Config, it is returned as is.


inp (str | dict | Config) – a URI to a JSON file or a dict.

Return type


dict(with_rv_metadata: bool = False, **kwargs) dict#

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.


with_rv_metadata (bool) –

Return type


classmethod from_dict(cfg_dict: dict) Self#

Deserialize Config from a dict.


cfg_dict (dict) – Dict to deserialize.

Return type


classmethod from_file(uri: str) Self#

Deserialize Config from a JSON file, upgrading if possible.


uri (str) – URI to load from.

Return type



Recursively validate hierarchies of Configs.

This uses reflection to call validate_config on a hierarchy of Configs using a depth-first pre-order traversal.


Re-validate an instantiated Config.

Runs all Pydantic validators plus self.validate_config().

Adapted from:

to_file(uri: str, with_rv_metadata: bool = True) None#

Save a Config to a JSON file, optionally with RV metadata.

  • uri (str) – URI to save to.

  • with_rv_metadata (bool) – If True, inject Raster Vision metadata such as plugin_versions, so that the config can be upgraded when loaded.

Return type


update(*args, **kwargs)#

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.


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.

validate_list(field: str, valid_options: List[str])#

Validate a list field.

  • field (str) – name of field to validate

  • valid_options (List[str]) – values that field is allowed to take


ConfigError – if field is invalid