# packages

pkgId: 4849df8f82b5d820ba63dd27d9882e43a79d3480a72012fc284845970d9265f6
name: python-airsmodel
arch: src
version: 0.5.0
epoch: 0
release: 1
summary: ARLAS Item Registration Service Model
url: https://pypi.org/project/airsmodel/
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-airsmodel-0.5.0-1.src.rpm
checksum_type: sha256
description:
  This package contains the data model for sending requests to ARLAS Item Registration Services.


  ```txt
  airs_model
  ```



  | Abstract            | Extensible | Status         | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                              |
  | :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------- |
  | Can be instantiated | No         | Unknown status | No           | Forbidden         | Allowed               | none                | [model.schema.json](../../out/model.schema.json "open original schema") |



  `object` ([Item](model.md))



  | Property                  | Type   | Required | Nullable       | Defined by                                                                                                                                                                                                                                                             |
  | :------------------------ | :----- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | [collection](#collection) | Merged | Optional | cannot be null | [Item](model-properties-name-of-the-collection-the-item-belongs-to.md "airs_model#/properties/collection")                                                                                                                                                             |
  | [catalog](#catalog)       | Merged | Optional | cannot be null | [Item](model-properties-name-of-the-catalog-the-item-belongs-to.md "airs_model#/properties/catalog")                                                                                                                                                                   |
  | [id](#id)                 | Merged | Optional | cannot be null | [Item](model-properties-unique-item-identifier-must-be-unique-within-the-collection.md "airs_model#/properties/id")                                                                                                                                                    |
  | [geometry](#geometry)     | Merged | Optional | cannot be null | [Item](model-properties-defines-the-full-footprint-of-the-asset-represented-by-this-item-formatted-according-to-rfc-7946-section-31-geojson-httpstoolsietforghtmlrfc7946_.md "airs_model#/properties/geometry")                                                        |
  | [bbox](#bbox)             | Merged | Optional | cannot be null | [Item](model-properties-bounding-box-of-the-asset-represented-by-this-item-using-either-2d-or-3d-geometries-the-length-of-the-array-must-be-2n-where-n-is-the-number-of-dimensions-could-also-be-none-in-the-case-of-a-null-geometry.md "airs_model#/properties/bbox") |
  | [centroid](#centroid)     | Merged | Optional | cannot be null | [Item](model-properties-coordinates-lonlat-of-the-geometrys-centroid.md "airs_model#/properties/centroid")                                                                                                                                                             |
  | [assets](#assets)         | Merged | Optional | cannot be null | [Item](model-properties-a-dictionary-mapping-string-keys-to-asset-objects-all-asset-values-in-the-dictionary-will-have-their-owner-attribute-set-to-the-created-item.md "airs_model#/properties/assets")                                                               |
  | [properties](#properties) | Merged | Optional | cannot be null | [Item](model-properties-item-properties.md "airs_model#/properties/properties")                                                                                                                                                                                        |
  | Additional Properties     | Any    | Optional | can be null    |                                                                                                                                                                                                                                                                        |





  `collection`

  *   is optional

  *   Type: merged type ([Name of the collection the item belongs to.](model-properties-name-of-the-collection-the-item-belongs-to.md))

  *   cannot be null

  *   defined in: [Item](model-properties-name-of-the-collection-the-item-belongs-to.md "airs_model#/properties/collection")



  merged type ([Name of the collection the item belongs to.](model-properties-name-of-the-collection-the-item-belongs-to.md))

  any of

  *   [Untitled string in Item](model-properties-name-of-the-collection-the-item-belongs-to-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-properties-name-of-the-collection-the-item-belongs-to-anyof-1.md "check type definition")





  `catalog`

  *   is optional

  *   Type: merged type ([Name of the catalog the item belongs to.](model-properties-name-of-the-catalog-the-item-belongs-to.md))

  *   cannot be null

  *   defined in: [Item](model-properties-name-of-the-catalog-the-item-belongs-to.md "airs_model#/properties/catalog")



  merged type ([Name of the catalog the item belongs to.](model-properties-name-of-the-catalog-the-item-belongs-to.md))

  any of

  *   [Untitled string in Item](model-properties-name-of-the-catalog-the-item-belongs-to-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-properties-name-of-the-catalog-the-item-belongs-to-anyof-1.md "check type definition")





  `id`

  *   is optional

  *   Type: merged type ([Unique item identifier. Must be unique within the collection.](model-properties-unique-item-identifier-must-be-unique-within-the-collection.md))

  *   cannot be null

  *   defined in: [Item](model-properties-unique-item-identifier-must-be-unique-within-the-collection.md "airs_model#/properties/id")



  merged type ([Unique item identifier. Must be unique within the collection.](model-properties-unique-item-identifier-must-be-unique-within-the-collection.md))

  any of

  *   [Untitled string in Item](model-properties-unique-item-identifier-must-be-unique-within-the-collection-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-properties-unique-item-identifier-must-be-unique-within-the-collection-anyof-1.md "check type definition")





  `geometry`

  *   is optional

  *   Type: merged type ([Defines the full footprint of the asset represented by this item, formatted according to \`RFC 7946, section 3.1 (GeoJSON) \<https://tools.ietf.org/html/rfc7946>\`\_](model-properties-defines-the-full-footprint-of-the-asset-represented-by-this-item-formatted-according-to-rfc-7946-section-31-geojson-httpstoolsietforghtmlrfc7946_.md))

  *   cannot be null

  *   defined in: [Item](model-properties-defines-the-full-footprint-of-the-asset-represented-by-this-item-formatted-according-to-rfc-7946-section-31-geojson-httpstoolsietforghtmlrfc7946_.md "airs_model#/properties/geometry")



  merged type ([Defines the full footprint of the asset represented by this item, formatted according to \`RFC 7946, section 3.1 (GeoJSON) \<https://tools.ietf.org/html/rfc7946>\`\_](model-properties-defines-the-full-footprint-of-the-asset-represented-by-this-item-formatted-according-to-rfc-7946-section-31-geojson-httpstoolsietforghtmlrfc7946_.md))

  any of

  *   [Untitled object in Item](model-properties-defines-the-full-footprint-of-the-asset-represented-by-this-item-formatted-according-to-rfc-7946-section-31-geojson-httpstoolsietforghtmlrfc7946_-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-properties-defines-the-full-footprint-of-the-asset-represented-by-this-item-formatted-according-to-rfc-7946-section-31-geojson-httpstoolsietforghtmlrfc7946_-anyof-1.md "check type definition")





  `bbox`

  *   is optional

  *   Type: merged type ([Bounding Box of the asset represented by this item using either 2D or 3D geometries. The length of the array must be 2\*n where n is the number of dimensions. Could also be None in the case of a null geometry.](model-properties-bounding-box-of-the-asset-represented-by-this-item-using-either-2d-or-3d-geometries-the-length-of-the-array-must-be-2n-where-n-is-the-number-of-dimensions-could-also-be-none-in-the-case-of-a-null-geometry.md))

  *   cannot be null

  *   defined in: [Item](model-properties-bounding-box-of-the-asset-represented-by-this-item-using-either-2d-or-3d-geometries-the-length-of-the-array-must-be-2n-where-n-is-the-number-of-dimensions-could-also-be-none-in-the-case-of-a-null-geometry.md "airs_model#/properties/bbox")



  merged type ([Bounding Box of the asset represented by this item using either 2D or 3D geometries. The length of the array must be 2\*n where n is the number of dimensions. Could also be None in the case of a null geometry.](model-properties-bounding-box-of-the-asset-represented-by-this-item-using-either-2d-or-3d-geometries-the-length-of-the-array-must-be-2n-where-n-is-the-number-of-dimensions-could-also-be-none-in-the-case-of-a-null-geometry.md))

  any of

  *   [Untitled array in Item](model-properties-bounding-box-of-the-asset-represented-by-this-item-using-either-2d-or-3d-geometries-the-length-of-the-array-must-be-2n-where-n-is-the-number-of-dimensions-could-also-be-none-in-the-case-of-a-null-geometry-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-properties-bounding-box-of-the-asset-represented-by-this-item-using-either-2d-or-3d-geometries-the-length-of-the-array-must-be-2n-where-n-is-the-number-of-dimensions-could-also-be-none-in-the-case-of-a-null-geometry-anyof-1.md "check type definition")





  `centroid`

  *   is optional

  *   Type: merged type ([Coordinates (lon/lat) of the geometry's centroid.](model-properties-coordinates-lonlat-of-the-geometrys-centroid.md))

  *   cannot be null

  *   defined in: [Item](model-properties-coordinates-lonlat-of-the-geometrys-centroid.md "airs_model#/properties/centroid")



  merged type ([Coordinates (lon/lat) of the geometry's centroid.](model-properties-coordinates-lonlat-of-the-geometrys-centroid.md))

  any of

  *   [Untitled array in Item](model-properties-coordinates-lonlat-of-the-geometrys-centroid-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-properties-coordinates-lonlat-of-the-geometrys-centroid-anyof-1.md "check type definition")





  `assets`

  *   is optional

  *   Type: merged type ([A dictionary mapping string keys to Asset objects. All Asset values in the dictionary will have their owner attribute set to the created Item.](model-properties-a-dictionary-mapping-string-keys-to-asset-objects-all-asset-values-in-the-dictionary-will-have-their-owner-attribute-set-to-the-created-item.md))

  *   cannot be null

  *   defined in: [Item](model-properties-a-dictionary-mapping-string-keys-to-asset-objects-all-asset-values-in-the-dictionary-will-have-their-owner-attribute-set-to-the-created-item.md "airs_model#/properties/assets")



  merged type ([A dictionary mapping string keys to Asset objects. All Asset values in the dictionary will have their owner attribute set to the created Item.](model-properties-a-dictionary-mapping-string-keys-to-asset-objects-all-asset-values-in-the-dictionary-will-have-their-owner-attribute-set-to-the-created-item.md))

  any of

  *   [Untitled object in Item](model-properties-a-dictionary-mapping-string-keys-to-asset-objects-all-asset-values-in-the-dictionary-will-have-their-owner-attribute-set-to-the-created-item-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-properties-a-dictionary-mapping-string-keys-to-asset-objects-all-asset-values-in-the-dictionary-will-have-their-owner-attribute-set-to-the-created-item-anyof-1.md "check type definition")





  `properties`

  *   is optional

  *   Type: merged type ([Item properties](model-properties-item-properties.md))

  *   cannot be null

  *   defined in: [Item](model-properties-item-properties.md "airs_model#/properties/properties")



  merged type ([Item properties](model-properties-item-properties.md))

  any of

  *   [Properties](model-defs-properties.md "check type definition")

  *   [Untitled null in Item](model-properties-item-properties-anyof-1.md "check type definition")



  Additional properties are allowed and do not have to follow a specific schema





  Reference this group by using

  ```json
  {"$ref":"airs_model#/$defs/Asset"}
  ```

  | Property                                                          | Type   | Required | Nullable       | Defined by                                                                                                                                                                                                                                                                            |
  | :---------------------------------------------------------------- | :----- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
  | [name](#name)                                                     | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-assets-name-but-be-the-same-as-the-key-in-the-assets-dictionary.md "airs_model#/$defs/Asset/properties/name")                                                                                                                                      |
  | [size](#size)                                                     | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-assets-size-in-bytes.md "airs_model#/$defs/Asset/properties/size")                                                                                                                                                                                 |
  | [href](#href)                                                     | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-absolute-link-to-the-asset-object.md "airs_model#/$defs/Asset/properties/href")                                                                                                                                                                    |
  | [asset\_type](#asset_type)                                        | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-type-of-data-resourcetype.md "airs_model#/$defs/Asset/properties/asset_type")                                                                                                                                                                      |
  | [asset\_format](#asset_format)                                    | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-data-format-assetformat.md "airs_model#/$defs/Asset/properties/asset_format")                                                                                                                                                                      |
  | [storage\_\_requester\_pays](#storage__requester_pays)            | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-is-the-data-requester-pays-or-is-it-data-managercloud-provider-pays-defaults-to-false-whether-the-requester-pays-for-accessing-assets.md "airs_model#/$defs/Asset/properties/storage__requester_pays")                                             |
  | [storage\_\_tier](#storage__tier)                                 | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-cloud-provider-storage-tiers-standard-glacier-etc.md "airs_model#/$defs/Asset/properties/storage__tier")                                                                                                                                           |
  | [storage\_\_platform](#storage__platform)                         | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-paas-solutions-alibaba-aws-azure-gcp-ibm-oracle-other.md "airs_model#/$defs/Asset/properties/storage__platform")                                                                                                                                   |
  | [storage\_\_region](#storage__region)                             | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-the-region-where-the-data-is-stored-relevant-to-speed-of-access-and-inter-region-egress-costs-as-defined-by-paas-provider.md "airs_model#/$defs/Asset/properties/storage__region")                                                                 |
  | [airs\_\_managed](#airs__managed)                                 | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-whether-the-asset-is-managed-by-airs-or-not.md "airs_model#/$defs/Asset/properties/airs__managed")                                                                                                                                                 |
  | [airs\_\_object\_store\_bucket](#airs__object_store_bucket)       | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-object-store-bucket-for-the-asset-object.md "airs_model#/$defs/Asset/properties/airs__object_store_bucket")                                                                                                                                        |
  | [airs\_\_object\_store\_key](#airs__object_store_key)             | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-object-store-key-of-the-asset-object.md "airs_model#/$defs/Asset/properties/airs__object_store_key")                                                                                                                                               |
  | [title](#title)                                                   | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-optional-displayed-title-for-clients-and-users.md "airs_model#/$defs/Asset/properties/title")                                                                                                                                                      |
  | [description](#description)                                       | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-a-description-of-the-asset-providing-additional-details-such-as-how-it-was-processed-or-created-commonmark-029-syntax-may-be-used-for-rich-text-representation.md "airs_model#/$defs/Asset/properties/description")                                |
  | [type](#type)                                                     | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-optional-description-of-the-media-type-registered-media-types-are-preferred-see-mediatype-for-common-media-types.md "airs_model#/$defs/Asset/properties/type")                                                                                     |
  | [roles](#roles)                                                   | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-optional-semantic-roles-ie-thumbnail-overview-data-metadata-of-the-asset.md "airs_model#/$defs/Asset/properties/roles")                                                                                                                            |
  | [extra\_fields](#extra_fields)                                    | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-optional-additional-fields-for-this-asset-this-is-used-by-extensions-as-a-way-to-serialize-and-deserialize-properties-on-asset-object-json.md "airs_model#/$defs/Asset/properties/extra_fields")                                                   |
  | [gsd](#gsd)                                                       | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-ground-sampling-distance-resolution-of-the-asset.md "airs_model#/$defs/Asset/properties/gsd")                                                                                                                                                      |
  | [eo\_\_bands](#eo__bands)                                         | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-an-array-of-available-bands-where-each-object-is-a-band-object-if-given-requires-at-least-one-band.md "airs_model#/$defs/Asset/properties/eo__bands")                                                                                              |
  | [sar\_\_instrument\_mode](#sar__instrument_mode)                  | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-the-name-of-the-sensor-acquisition-mode-that-is-commonly-used-this-should-be-the-short-name-if-available-for-example-wv-for-wave-mode-of-sentinel-1-and-envisat-asar-satellites.md "airs_model#/$defs/Asset/properties/sar__instrument_mode")      |
  | [sar\_\_frequency\_band](#sar__frequency_band)                    | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-the-common-name-for-the-frequency-band-to-make-it-easier-to-search-for-bands-across-instruments-see-section-common-frequency-band-names-for-a-list-of-accepted-names.md "airs_model#/$defs/Asset/properties/sar__frequency_band")                  |
  | [sar\_\_center\_frequency](#sar__center_frequency)                | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-the-center-frequency-of-the-instrument-in-gigahertz-ghz.md "airs_model#/$defs/Asset/properties/sar__center_frequency")                                                                                                                             |
  | [sar\_\_polarizations](#sar__polarizations)                       | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-any-combination-of-polarizations.md "airs_model#/$defs/Asset/properties/sar__polarizations")                                                                                                                                                       |
  | [sar\_\_product\_type](#sar__product_type)                        | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-the-product-type-for-example-ssc-mgd-or-sgc.md "airs_model#/$defs/Asset/properties/sar__product_type")                                                                                                                                             |
  | [sar\_\_resolution\_range](#sar__resolution_range)                | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-the-range-resolution-which-is-the-maximum-ability-to-distinguish-two-adjacent-targets-perpendicular-to-the-flight-path-in-meters-m.md "airs_model#/$defs/Asset/properties/sar__resolution_range")                                                  |
  | [sar\_\_resolution\_azimuth](#sar__resolution_azimuth)            | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-the-azimuth-resolution-which-is-the-maximum-ability-to-distinguish-two-adjacent-targets-parallel-to-the-flight-path-in-meters-m.md "airs_model#/$defs/Asset/properties/sar__resolution_azimuth")                                                   |
  | [sar\_\_pixel\_spacing\_range](#sar__pixel_spacing_range)         | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-the-range-pixel-spacing-which-is-the-distance-between-adjacent-pixels-perpendicular-to-the-flight-path-in-meters-m-strongly-recommended-to-be-specified-for-products-of-type-grd.md "airs_model#/$defs/Asset/properties/sar__pixel_spacing_range") |
  | [sar\_\_pixel\_spacing\_azimuth](#sar__pixel_spacing_azimuth)     | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-the-azimuth-pixel-spacing-which-is-the-distance-between-adjacent-pixels-parallel-to-the-flight-path-in-meters-m-strongly-recommended-to-be-specified-for-products-of-type-grd.md "airs_model#/$defs/Asset/properties/sar__pixel_spacing_azimuth")  |
  | [sar\_\_looks\_range](#sar__looks_range)                          | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-number-of-range-looks-which-is-the-number-of-groups-of-signal-samples-looks-perpendicular-to-the-flight-path.md "airs_model#/$defs/Asset/properties/sar__looks_range")                                                                             |
  | [sar\_\_looks\_azimuth](#sar__looks_azimuth)                      | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-number-of-azimuth-looks-which-is-the-number-of-groups-of-signal-samples-looks-parallel-to-the-flight-path.md "airs_model#/$defs/Asset/properties/sar__looks_azimuth")                                                                              |
  | [sar\_\_looks\_equivalent\_number](#sar__looks_equivalent_number) | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-the-equivalent-number-of-looks-enl.md "airs_model#/$defs/Asset/properties/sar__looks_equivalent_number")                                                                                                                                           |
  | [sar\_\_observation\_direction](#sar__observation_direction)      | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-antenna-pointing-direction-relative-to-the-flight-trajectory-of-the-satellite-either-left-or-right.md "airs_model#/$defs/Asset/properties/sar__observation_direction")                                                                             |
  | [proj\_\_epsg](#proj__epsg)                                       | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-epsg-code-of-the-datasource.md "airs_model#/$defs/Asset/properties/proj__epsg")                                                                                                                                                                    |
  | [proj\_\_wkt2](#proj__wkt2)                                       | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-projjson-object-representing-the-coordinate-reference-system-crs-that-the-projgeometry-and-projbbox-fields-represent.md "airs_model#/$defs/Asset/properties/proj__wkt2")                                                                           |
  | [proj\_\_geometry](#proj__geometry)                               | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-defines-the-footprint-of-this-item.md "airs_model#/$defs/Asset/properties/proj__geometry")                                                                                                                                                         |
  | [proj\_\_bbox](#proj__bbox)                                       | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-bounding-box-of-the-item-in-the-asset-crs-in-2-or-3-dimensions.md "airs_model#/$defs/Asset/properties/proj__bbox")                                                                                                                                 |
  | [proj\_\_centroid](#proj__centroid)                               | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-coordinates-representing-the-centroid-of-the-item-in-latlong.md "airs_model#/$defs/Asset/properties/proj__centroid")                                                                                                                               |
  | [proj\_\_shape](#proj__shape)                                     | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-number-of-pixels-in-y-and-x-directions-for-the-default-grid.md "airs_model#/$defs/Asset/properties/proj__shape")                                                                                                                                   |
  | [proj\_\_transform](#proj__transform)                             | Merged | Optional | cannot be null | [Item](model-defs-asset-properties-the-affine-transformation-coefficients-for-the-default-grid.md "airs_model#/$defs/Asset/properties/proj__transform")                                                                                                                               |
  | Additional Properties                                             | Any    | Optional | can be null    |                                                                                                                                                                                                                                                                                       |





  `name`

  *   is optional

  *   Type: merged type ([Asset's name. But be the same as the key in the \`assets\` dictionary.](model-defs-asset-properties-assets-name-but-be-the-same-as-the-key-in-the-assets-dictionary.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-assets-name-but-be-the-same-as-the-key-in-the-assets-dictionary.md "airs_model#/$defs/Asset/properties/name")



  merged type ([Asset's name. But be the same as the key in the \`assets\` dictionary.](model-defs-asset-properties-assets-name-but-be-the-same-as-the-key-in-the-assets-dictionary.md))

  any of

  *   [Untitled string in Item](model-defs-asset-properties-assets-name-but-be-the-same-as-the-key-in-the-assets-dictionary-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-assets-name-but-be-the-same-as-the-key-in-the-assets-dictionary-anyof-1.md "check type definition")





  `size`

  *   is optional

  *   Type: merged type ([Asset's size in Bytes.](model-defs-asset-properties-assets-size-in-bytes.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-assets-size-in-bytes.md "airs_model#/$defs/Asset/properties/size")



  merged type ([Asset's size in Bytes.](model-defs-asset-properties-assets-size-in-bytes.md))

  any of

  *   [Untitled integer in Item](model-defs-asset-properties-assets-size-in-bytes-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-assets-size-in-bytes-anyof-1.md "check type definition")





  `href`

  *   is optional

  *   Type: merged type ([Absolute link to the asset object.](model-defs-asset-properties-absolute-link-to-the-asset-object.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-absolute-link-to-the-asset-object.md "airs_model#/$defs/Asset/properties/href")



  merged type ([Absolute link to the asset object.](model-defs-asset-properties-absolute-link-to-the-asset-object.md))

  any of

  *   [Untitled string in Item](model-defs-asset-properties-absolute-link-to-the-asset-object-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-absolute-link-to-the-asset-object-anyof-1.md "check type definition")





  `asset_type`

  *   is optional

  *   Type: merged type ([Type of data (ResourceType)](model-defs-asset-properties-type-of-data-resourcetype.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-type-of-data-resourcetype.md "airs_model#/$defs/Asset/properties/asset_type")



  merged type ([Type of data (ResourceType)](model-defs-asset-properties-type-of-data-resourcetype.md))

  any of

  *   [Untitled string in Item](model-defs-asset-properties-type-of-data-resourcetype-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-type-of-data-resourcetype-anyof-1.md "check type definition")





  `asset_format`

  *   is optional

  *   Type: merged type ([Data format (AssetFormat)](model-defs-asset-properties-data-format-assetformat.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-data-format-assetformat.md "airs_model#/$defs/Asset/properties/asset_format")



  merged type ([Data format (AssetFormat)](model-defs-asset-properties-data-format-assetformat.md))

  any of

  *   [Untitled string in Item](model-defs-asset-properties-data-format-assetformat-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-data-format-assetformat-anyof-1.md "check type definition")





  `storage__requester_pays`

  *   is optional

  *   Type: merged type ([Is the data requester pays or is it data manager/cloud provider pays. Defaults to false. Whether the requester pays for accessing assets](model-defs-asset-properties-is-the-data-requester-pays-or-is-it-data-managercloud-provider-pays-defaults-to-false-whether-the-requester-pays-for-accessing-assets.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-is-the-data-requester-pays-or-is-it-data-managercloud-provider-pays-defaults-to-false-whether-the-requester-pays-for-accessing-assets.md "airs_model#/$defs/Asset/properties/storage__requester_pays")



  merged type ([Is the data requester pays or is it data manager/cloud provider pays. Defaults to false. Whether the requester pays for accessing assets](model-defs-asset-properties-is-the-data-requester-pays-or-is-it-data-managercloud-provider-pays-defaults-to-false-whether-the-requester-pays-for-accessing-assets.md))

  any of

  *   [Untitled boolean in Item](model-defs-asset-properties-is-the-data-requester-pays-or-is-it-data-managercloud-provider-pays-defaults-to-false-whether-the-requester-pays-for-accessing-assets-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-is-the-data-requester-pays-or-is-it-data-managercloud-provider-pays-defaults-to-false-whether-the-requester-pays-for-accessing-assets-anyof-1.md "check type definition")





  `storage__tier`

  *   is optional

  *   Type: merged type ([Cloud Provider Storage Tiers (Standard, Glacier, etc.)](model-defs-asset-properties-cloud-provider-storage-tiers-standard-glacier-etc.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-cloud-provider-storage-tiers-standard-glacier-etc.md "airs_model#/$defs/Asset/properties/storage__tier")



  merged type ([Cloud Provider Storage Tiers (Standard, Glacier, etc.)](model-defs-asset-properties-cloud-provider-storage-tiers-standard-glacier-etc.md))

  any of

  *   [Untitled string in Item](model-defs-asset-properties-cloud-provider-storage-tiers-standard-glacier-etc-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-cloud-provider-storage-tiers-standard-glacier-etc-anyof-1.md "check type definition")





  `storage__platform`

  *   is optional

  *   Type: merged type ([PaaS solutions (ALIBABA, AWS, AZURE, GCP, IBM, ORACLE, OTHER)](model-defs-asset-properties-paas-solutions-alibaba-aws-azure-gcp-ibm-oracle-other.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-paas-solutions-alibaba-aws-azure-gcp-ibm-oracle-other.md "airs_model#/$defs/Asset/properties/storage__platform")



  merged type ([PaaS solutions (ALIBABA, AWS, AZURE, GCP, IBM, ORACLE, OTHER)](model-defs-asset-properties-paas-solutions-alibaba-aws-azure-gcp-ibm-oracle-other.md))

  any of

  *   [Untitled string in Item](model-defs-asset-properties-paas-solutions-alibaba-aws-azure-gcp-ibm-oracle-other-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-paas-solutions-alibaba-aws-azure-gcp-ibm-oracle-other-anyof-1.md "check type definition")





  `storage__region`

  *   is optional

  *   Type: merged type ([The region where the data is stored. Relevant to speed of access and inter region egress costs (as defined by PaaS provider)](model-defs-asset-properties-the-region-where-the-data-is-stored-relevant-to-speed-of-access-and-inter-region-egress-costs-as-defined-by-paas-provider.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-the-region-where-the-data-is-stored-relevant-to-speed-of-access-and-inter-region-egress-costs-as-defined-by-paas-provider.md "airs_model#/$defs/Asset/properties/storage__region")



  merged type ([The region where the data is stored. Relevant to speed of access and inter region egress costs (as defined by PaaS provider)](model-defs-asset-properties-the-region-where-the-data-is-stored-relevant-to-speed-of-access-and-inter-region-egress-costs-as-defined-by-paas-provider.md))

  any of

  *   [Untitled string in Item](model-defs-asset-properties-the-region-where-the-data-is-stored-relevant-to-speed-of-access-and-inter-region-egress-costs-as-defined-by-paas-provider-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-the-region-where-the-data-is-stored-relevant-to-speed-of-access-and-inter-region-egress-costs-as-defined-by-paas-provider-anyof-1.md "check type definition")





  `airs__managed`

  *   is optional

  *   Type: merged type ([Whether the asset is managed by AIRS or not.](model-defs-asset-properties-whether-the-asset-is-managed-by-airs-or-not.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-whether-the-asset-is-managed-by-airs-or-not.md "airs_model#/$defs/Asset/properties/airs__managed")



  merged type ([Whether the asset is managed by AIRS or not.](model-defs-asset-properties-whether-the-asset-is-managed-by-airs-or-not.md))

  any of

  *   [Untitled boolean in Item](model-defs-asset-properties-whether-the-asset-is-managed-by-airs-or-not-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-whether-the-asset-is-managed-by-airs-or-not-anyof-1.md "check type definition")



  The default value is:

  ```json
  true
  ```





  `airs__object_store_bucket`

  *   is optional

  *   Type: merged type ([Object store bucket for the asset object.](model-defs-asset-properties-object-store-bucket-for-the-asset-object.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-object-store-bucket-for-the-asset-object.md "airs_model#/$defs/Asset/properties/airs__object_store_bucket")



  merged type ([Object store bucket for the asset object.](model-defs-asset-properties-object-store-bucket-for-the-asset-object.md))

  any of

  *   [Untitled string in Item](model-defs-asset-properties-object-store-bucket-for-the-asset-object-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-object-store-bucket-for-the-asset-object-anyof-1.md "check type definition")





  `airs__object_store_key`

  *   is optional

  *   Type: merged type ([Object store key of the asset object.](model-defs-asset-properties-object-store-key-of-the-asset-object.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-object-store-key-of-the-asset-object.md "airs_model#/$defs/Asset/properties/airs__object_store_key")



  merged type ([Object store key of the asset object.](model-defs-asset-properties-object-store-key-of-the-asset-object.md))

  any of

  *   [Untitled string in Item](model-defs-asset-properties-object-store-key-of-the-asset-object-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-object-store-key-of-the-asset-object-anyof-1.md "check type definition")





  `title`

  *   is optional

  *   Type: merged type ([Optional displayed title for clients and users.](model-defs-asset-properties-optional-displayed-title-for-clients-and-users.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-optional-displayed-title-for-clients-and-users.md "airs_model#/$defs/Asset/properties/title")



  merged type ([Optional displayed title for clients and users.](model-defs-asset-properties-optional-displayed-title-for-clients-and-users.md))

  any of

  *   [Untitled string in Item](model-defs-asset-properties-optional-displayed-title-for-clients-and-users-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-optional-displayed-title-for-clients-and-users-anyof-1.md "check type definition")





  `description`

  *   is optional

  *   Type: merged type ([A description of the Asset providing additional details, such as how it was processed or created. CommonMark 0.29 syntax MAY be used for rich text representation.](model-defs-asset-properties-a-description-of-the-asset-providing-additional-details-such-as-how-it-was-processed-or-created-commonmark-029-syntax-may-be-used-for-rich-text-representation.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-a-description-of-the-asset-providing-additional-details-such-as-how-it-was-processed-or-created-commonmark-029-syntax-may-be-used-for-rich-text-representation.md "airs_model#/$defs/Asset/properties/description")



  merged type ([A description of the Asset providing additional details, such as how it was processed or created. CommonMark 0.29 syntax MAY be used for rich text representation.](model-defs-asset-properties-a-description-of-the-asset-providing-additional-details-such-as-how-it-was-processed-or-created-commonmark-029-syntax-may-be-used-for-rich-text-representation.md))

  any of

  *   [Untitled string in Item](model-defs-asset-properties-a-description-of-the-asset-providing-additional-details-such-as-how-it-was-processed-or-created-commonmark-029-syntax-may-be-used-for-rich-text-representation-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-a-description-of-the-asset-providing-additional-details-such-as-how-it-was-processed-or-created-commonmark-029-syntax-may-be-used-for-rich-text-representation-anyof-1.md "check type definition")





  `type`

  *   is optional

  *   Type: merged type ([Optional description of the media type. Registered Media Types are preferred. See MediaType for common media types.](model-defs-asset-properties-optional-description-of-the-media-type-registered-media-types-are-preferred-see-mediatype-for-common-media-types.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-optional-description-of-the-media-type-registered-media-types-are-preferred-see-mediatype-for-common-media-types.md "airs_model#/$defs/Asset/properties/type")



  merged type ([Optional description of the media type. Registered Media Types are preferred. See MediaType for common media types.](model-defs-asset-properties-optional-description-of-the-media-type-registered-media-types-are-preferred-see-mediatype-for-common-media-types.md))

  any of

  *   [Untitled string in Item](model-defs-asset-properties-optional-description-of-the-media-type-registered-media-types-are-preferred-see-mediatype-for-common-media-types-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-optional-description-of-the-media-type-registered-media-types-are-preferred-see-mediatype-for-common-media-types-anyof-1.md "check type definition")





  `roles`

  *   is optional

  *   Type: merged type ([Optional, Semantic roles (i.e. thumbnail, overview, data, metadata) of the asset.](model-defs-asset-properties-optional-semantic-roles-ie-thumbnail-overview-data-metadata-of-the-asset.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-optional-semantic-roles-ie-thumbnail-overview-data-metadata-of-the-asset.md "airs_model#/$defs/Asset/properties/roles")



  merged type ([Optional, Semantic roles (i.e. thumbnail, overview, data, metadata) of the asset.](model-defs-asset-properties-optional-semantic-roles-ie-thumbnail-overview-data-metadata-of-the-asset.md))

  any of

  *   [Untitled array in Item](model-defs-asset-properties-optional-semantic-roles-ie-thumbnail-overview-data-metadata-of-the-asset-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-optional-semantic-roles-ie-thumbnail-overview-data-metadata-of-the-asset-anyof-1.md "check type definition")





  `extra_fields`

  *   is optional

  *   Type: merged type ([Optional, additional fields for this asset. This is used by extensions as a way to serialize and deserialize properties on asset object JSON.](model-defs-asset-properties-optional-additional-fields-for-this-asset-this-is-used-by-extensions-as-a-way-to-serialize-and-deserialize-properties-on-asset-object-json.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-optional-additional-fields-for-this-asset-this-is-used-by-extensions-as-a-way-to-serialize-and-deserialize-properties-on-asset-object-json.md "airs_model#/$defs/Asset/properties/extra_fields")



  merged type ([Optional, additional fields for this asset. This is used by extensions as a way to serialize and deserialize properties on asset object JSON.](model-defs-asset-properties-optional-additional-fields-for-this-asset-this-is-used-by-extensions-as-a-way-to-serialize-and-deserialize-properties-on-asset-object-json.md))

  any of

  *   [Untitled object in Item](model-defs-asset-properties-optional-additional-fields-for-this-asset-this-is-used-by-extensions-as-a-way-to-serialize-and-deserialize-properties-on-asset-object-json-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-optional-additional-fields-for-this-asset-this-is-used-by-extensions-as-a-way-to-serialize-and-deserialize-properties-on-asset-object-json-anyof-1.md "check type definition")





  `gsd`

  *   is optional

  *   Type: merged type ([Ground Sampling Distance (resolution) of the asset](model-defs-asset-properties-ground-sampling-distance-resolution-of-the-asset.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-ground-sampling-distance-resolution-of-the-asset.md "airs_model#/$defs/Asset/properties/gsd")



  merged type ([Ground Sampling Distance (resolution) of the asset](model-defs-asset-properties-ground-sampling-distance-resolution-of-the-asset.md))

  any of

  *   [Untitled number in Item](model-defs-asset-properties-ground-sampling-distance-resolution-of-the-asset-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-ground-sampling-distance-resolution-of-the-asset-anyof-1.md "check type definition")





  `eo__bands`

  *   is optional

  *   Type: merged type ([An array of available bands where each object is a Band Object. If given, requires at least one band.](model-defs-asset-properties-an-array-of-available-bands-where-each-object-is-a-band-object-if-given-requires-at-least-one-band.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-an-array-of-available-bands-where-each-object-is-a-band-object-if-given-requires-at-least-one-band.md "airs_model#/$defs/Asset/properties/eo__bands")



  merged type ([An array of available bands where each object is a Band Object. If given, requires at least one band.](model-defs-asset-properties-an-array-of-available-bands-where-each-object-is-a-band-object-if-given-requires-at-least-one-band.md))

  any of

  *   [Untitled array in Item](model-defs-asset-properties-an-array-of-available-bands-where-each-object-is-a-band-object-if-given-requires-at-least-one-band-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-an-array-of-available-bands-where-each-object-is-a-band-object-if-given-requires-at-least-one-band-anyof-1.md "check type definition")





  `sar__instrument_mode`

  *   is optional

  *   Type: merged type ([The name of the sensor acquisition mode that is commonly used. This should be the short name, if available. For example, WV for "Wave mode" of Sentinel-1 and Envisat ASAR satellites.](model-defs-asset-properties-the-name-of-the-sensor-acquisition-mode-that-is-commonly-used-this-should-be-the-short-name-if-available-for-example-wv-for-wave-mode-of-sentinel-1-and-envisat-asar-satellites.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-the-name-of-the-sensor-acquisition-mode-that-is-commonly-used-this-should-be-the-short-name-if-available-for-example-wv-for-wave-mode-of-sentinel-1-and-envisat-asar-satellites.md "airs_model#/$defs/Asset/properties/sar__instrument_mode")



  merged type ([The name of the sensor acquisition mode that is commonly used. This should be the short name, if available. For example, WV for "Wave mode" of Sentinel-1 and Envisat ASAR satellites.](model-defs-asset-properties-the-name-of-the-sensor-acquisition-mode-that-is-commonly-used-this-should-be-the-short-name-if-available-for-example-wv-for-wave-mode-of-sentinel-1-and-envisat-asar-satellites.md))

  any of

  *   [Untitled string in Item](model-defs-asset-properties-the-name-of-the-sensor-acquisition-mode-that-is-commonly-used-this-should-be-the-short-name-if-available-for-example-wv-for-wave-mode-of-sentinel-1-and-envisat-asar-satellites-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-the-name-of-the-sensor-acquisition-mode-that-is-commonly-used-this-should-be-the-short-name-if-available-for-example-wv-for-wave-mode-of-sentinel-1-and-envisat-asar-satellites-anyof-1.md "check type definition")





  `sar__frequency_band`

  *   is optional

  *   Type: merged type ([The common name for the frequency band to make it easier to search for bands across instruments. See section "Common Frequency Band Names" for a list of accepted names.](model-defs-asset-properties-the-common-name-for-the-frequency-band-to-make-it-easier-to-search-for-bands-across-instruments-see-section-common-frequency-band-names-for-a-list-of-accepted-names.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-the-common-name-for-the-frequency-band-to-make-it-easier-to-search-for-bands-across-instruments-see-section-common-frequency-band-names-for-a-list-of-accepted-names.md "airs_model#/$defs/Asset/properties/sar__frequency_band")



  merged type ([The common name for the frequency band to make it easier to search for bands across instruments. See section "Common Frequency Band Names" for a list of accepted names.](model-defs-asset-properties-the-common-name-for-the-frequency-band-to-make-it-easier-to-search-for-bands-across-instruments-see-section-common-frequency-band-names-for-a-list-of-accepted-names.md))

  any of

  *   [Untitled string in Item](model-defs-asset-properties-the-common-name-for-the-frequency-band-to-make-it-easier-to-search-for-bands-across-instruments-see-section-common-frequency-band-names-for-a-list-of-accepted-names-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-the-common-name-for-the-frequency-band-to-make-it-easier-to-search-for-bands-across-instruments-see-section-common-frequency-band-names-for-a-list-of-accepted-names-anyof-1.md "check type definition")





  `sar__center_frequency`

  *   is optional

  *   Type: merged type ([The center frequency of the instrument, in gigahertz (GHz).](model-defs-asset-properties-the-center-frequency-of-the-instrument-in-gigahertz-ghz.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-the-center-frequency-of-the-instrument-in-gigahertz-ghz.md "airs_model#/$defs/Asset/properties/sar__center_frequency")



  merged type ([The center frequency of the instrument, in gigahertz (GHz).](model-defs-asset-properties-the-center-frequency-of-the-instrument-in-gigahertz-ghz.md))

  any of

  *   [Untitled number in Item](model-defs-asset-properties-the-center-frequency-of-the-instrument-in-gigahertz-ghz-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-the-center-frequency-of-the-instrument-in-gigahertz-ghz-anyof-1.md "check type definition")





  `sar__polarizations`

  *   is optional

  *   Type: merged type ([Any combination of polarizations.](model-defs-asset-properties-any-combination-of-polarizations.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-any-combination-of-polarizations.md "airs_model#/$defs/Asset/properties/sar__polarizations")



  merged type ([Any combination of polarizations.](model-defs-asset-properties-any-combination-of-polarizations.md))

  any of

  *   [Untitled string in Item](model-defs-asset-properties-any-combination-of-polarizations-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-any-combination-of-polarizations-anyof-1.md "check type definition")





  `sar__product_type`

  *   is optional

  *   Type: merged type ([The product type, for example SSC, MGD, or SGC](model-defs-asset-properties-the-product-type-for-example-ssc-mgd-or-sgc.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-the-product-type-for-example-ssc-mgd-or-sgc.md "airs_model#/$defs/Asset/properties/sar__product_type")



  merged type ([The product type, for example SSC, MGD, or SGC](model-defs-asset-properties-the-product-type-for-example-ssc-mgd-or-sgc.md))

  any of

  *   [Untitled string in Item](model-defs-asset-properties-the-product-type-for-example-ssc-mgd-or-sgc-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-the-product-type-for-example-ssc-mgd-or-sgc-anyof-1.md "check type definition")





  `sar__resolution_range`

  *   is optional

  *   Type: merged type ([The range resolution, which is the maximum ability to distinguish two adjacent targets perpendicular to the flight path, in meters (m).](model-defs-asset-properties-the-range-resolution-which-is-the-maximum-ability-to-distinguish-two-adjacent-targets-perpendicular-to-the-flight-path-in-meters-m.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-the-range-resolution-which-is-the-maximum-ability-to-distinguish-two-adjacent-targets-perpendicular-to-the-flight-path-in-meters-m.md "airs_model#/$defs/Asset/properties/sar__resolution_range")



  merged type ([The range resolution, which is the maximum ability to distinguish two adjacent targets perpendicular to the flight path, in meters (m).](model-defs-asset-properties-the-range-resolution-which-is-the-maximum-ability-to-distinguish-two-adjacent-targets-perpendicular-to-the-flight-path-in-meters-m.md))

  any of

  *   [Untitled number in Item](model-defs-asset-properties-the-range-resolution-which-is-the-maximum-ability-to-distinguish-two-adjacent-targets-perpendicular-to-the-flight-path-in-meters-m-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-the-range-resolution-which-is-the-maximum-ability-to-distinguish-two-adjacent-targets-perpendicular-to-the-flight-path-in-meters-m-anyof-1.md "check type definition")





  `sar__resolution_azimuth`

  *   is optional

  *   Type: merged type ([The azimuth resolution, which is the maximum ability to distinguish two adjacent targets parallel to the flight path, in meters (m).](model-defs-asset-properties-the-azimuth-resolution-which-is-the-maximum-ability-to-distinguish-two-adjacent-targets-parallel-to-the-flight-path-in-meters-m.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-the-azimuth-resolution-which-is-the-maximum-ability-to-distinguish-two-adjacent-targets-parallel-to-the-flight-path-in-meters-m.md "airs_model#/$defs/Asset/properties/sar__resolution_azimuth")



  merged type ([The azimuth resolution, which is the maximum ability to distinguish two adjacent targets parallel to the flight path, in meters (m).](model-defs-asset-properties-the-azimuth-resolution-which-is-the-maximum-ability-to-distinguish-two-adjacent-targets-parallel-to-the-flight-path-in-meters-m.md))

  any of

  *   [Untitled number in Item](model-defs-asset-properties-the-azimuth-resolution-which-is-the-maximum-ability-to-distinguish-two-adjacent-targets-parallel-to-the-flight-path-in-meters-m-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-the-azimuth-resolution-which-is-the-maximum-ability-to-distinguish-two-adjacent-targets-parallel-to-the-flight-path-in-meters-m-anyof-1.md "check type definition")





  `sar__pixel_spacing_range`

  *   is optional

  *   Type: merged type ([The range pixel spacing, which is the distance between adjacent pixels perpendicular to the flight path, in meters (m). Strongly RECOMMENDED to be specified for products of type GRD.](model-defs-asset-properties-the-range-pixel-spacing-which-is-the-distance-between-adjacent-pixels-perpendicular-to-the-flight-path-in-meters-m-strongly-recommended-to-be-specified-for-products-of-type-grd.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-the-range-pixel-spacing-which-is-the-distance-between-adjacent-pixels-perpendicular-to-the-flight-path-in-meters-m-strongly-recommended-to-be-specified-for-products-of-type-grd.md "airs_model#/$defs/Asset/properties/sar__pixel_spacing_range")



  merged type ([The range pixel spacing, which is the distance between adjacent pixels perpendicular to the flight path, in meters (m). Strongly RECOMMENDED to be specified for products of type GRD.](model-defs-asset-properties-the-range-pixel-spacing-which-is-the-distance-between-adjacent-pixels-perpendicular-to-the-flight-path-in-meters-m-strongly-recommended-to-be-specified-for-products-of-type-grd.md))

  any of

  *   [Untitled number in Item](model-defs-asset-properties-the-range-pixel-spacing-which-is-the-distance-between-adjacent-pixels-perpendicular-to-the-flight-path-in-meters-m-strongly-recommended-to-be-specified-for-products-of-type-grd-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-the-range-pixel-spacing-which-is-the-distance-between-adjacent-pixels-perpendicular-to-the-flight-path-in-meters-m-strongly-recommended-to-be-specified-for-products-of-type-grd-anyof-1.md "check type definition")





  `sar__pixel_spacing_azimuth`

  *   is optional

  *   Type: merged type ([The azimuth pixel spacing, which is the distance between adjacent pixels parallel to the flight path, in meters (m). Strongly RECOMMENDED to be specified for products of type GRD.](model-defs-asset-properties-the-azimuth-pixel-spacing-which-is-the-distance-between-adjacent-pixels-parallel-to-the-flight-path-in-meters-m-strongly-recommended-to-be-specified-for-products-of-type-grd.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-the-azimuth-pixel-spacing-which-is-the-distance-between-adjacent-pixels-parallel-to-the-flight-path-in-meters-m-strongly-recommended-to-be-specified-for-products-of-type-grd.md "airs_model#/$defs/Asset/properties/sar__pixel_spacing_azimuth")



  merged type ([The azimuth pixel spacing, which is the distance between adjacent pixels parallel to the flight path, in meters (m). Strongly RECOMMENDED to be specified for products of type GRD.](model-defs-asset-properties-the-azimuth-pixel-spacing-which-is-the-distance-between-adjacent-pixels-parallel-to-the-flight-path-in-meters-m-strongly-recommended-to-be-specified-for-products-of-type-grd.md))

  any of

  *   [Untitled number in Item](model-defs-asset-properties-the-azimuth-pixel-spacing-which-is-the-distance-between-adjacent-pixels-parallel-to-the-flight-path-in-meters-m-strongly-recommended-to-be-specified-for-products-of-type-grd-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-the-azimuth-pixel-spacing-which-is-the-distance-between-adjacent-pixels-parallel-to-the-flight-path-in-meters-m-strongly-recommended-to-be-specified-for-products-of-type-grd-anyof-1.md "check type definition")





  `sar__looks_range`

  *   is optional

  *   Type: merged type ([Number of range looks, which is the number of groups of signal samples (looks) perpendicular to the flight path.](model-defs-asset-properties-number-of-range-looks-which-is-the-number-of-groups-of-signal-samples-looks-perpendicular-to-the-flight-path.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-number-of-range-looks-which-is-the-number-of-groups-of-signal-samples-looks-perpendicular-to-the-flight-path.md "airs_model#/$defs/Asset/properties/sar__looks_range")



  merged type ([Number of range looks, which is the number of groups of signal samples (looks) perpendicular to the flight path.](model-defs-asset-properties-number-of-range-looks-which-is-the-number-of-groups-of-signal-samples-looks-perpendicular-to-the-flight-path.md))

  any of

  *   [Untitled number in Item](model-defs-asset-properties-number-of-range-looks-which-is-the-number-of-groups-of-signal-samples-looks-perpendicular-to-the-flight-path-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-number-of-range-looks-which-is-the-number-of-groups-of-signal-samples-looks-perpendicular-to-the-flight-path-anyof-1.md "check type definition")





  `sar__looks_azimuth`

  *   is optional

  *   Type: merged type ([Number of azimuth looks, which is the number of groups of signal samples (looks) parallel to the flight path.](model-defs-asset-properties-number-of-azimuth-looks-which-is-the-number-of-groups-of-signal-samples-looks-parallel-to-the-flight-path.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-number-of-azimuth-looks-which-is-the-number-of-groups-of-signal-samples-looks-parallel-to-the-flight-path.md "airs_model#/$defs/Asset/properties/sar__looks_azimuth")



  merged type ([Number of azimuth looks, which is the number of groups of signal samples (looks) parallel to the flight path.](model-defs-asset-properties-number-of-azimuth-looks-which-is-the-number-of-groups-of-signal-samples-looks-parallel-to-the-flight-path.md))

  any of

  *   [Untitled number in Item](model-defs-asset-properties-number-of-azimuth-looks-which-is-the-number-of-groups-of-signal-samples-looks-parallel-to-the-flight-path-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-number-of-azimuth-looks-which-is-the-number-of-groups-of-signal-samples-looks-parallel-to-the-flight-path-anyof-1.md "check type definition")





  `sar__looks_equivalent_number`

  *   is optional

  *   Type: merged type ([The equivalent number of looks (ENL).](model-defs-asset-properties-the-equivalent-number-of-looks-enl.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-the-equivalent-number-of-looks-enl.md "airs_model#/$defs/Asset/properties/sar__looks_equivalent_number")



  merged type ([The equivalent number of looks (ENL).](model-defs-asset-properties-the-equivalent-number-of-looks-enl.md))

  any of

  *   [Untitled number in Item](model-defs-asset-properties-the-equivalent-number-of-looks-enl-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-the-equivalent-number-of-looks-enl-anyof-1.md "check type definition")





  `sar__observation_direction`

  *   is optional

  *   Type: merged type ([Antenna pointing direction relative to the flight trajectory of the satellite, either left or right.](model-defs-asset-properties-antenna-pointing-direction-relative-to-the-flight-trajectory-of-the-satellite-either-left-or-right.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-antenna-pointing-direction-relative-to-the-flight-trajectory-of-the-satellite-either-left-or-right.md "airs_model#/$defs/Asset/properties/sar__observation_direction")



  merged type ([Antenna pointing direction relative to the flight trajectory of the satellite, either left or right.](model-defs-asset-properties-antenna-pointing-direction-relative-to-the-flight-trajectory-of-the-satellite-either-left-or-right.md))

  any of

  *   [Untitled string in Item](model-defs-asset-properties-antenna-pointing-direction-relative-to-the-flight-trajectory-of-the-satellite-either-left-or-right-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-antenna-pointing-direction-relative-to-the-flight-trajectory-of-the-satellite-either-left-or-right-anyof-1.md "check type definition")





  `proj__epsg`

  *   is optional

  *   Type: merged type ([EPSG code of the datasource.](model-defs-asset-properties-epsg-code-of-the-datasource.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-epsg-code-of-the-datasource.md "airs_model#/$defs/Asset/properties/proj__epsg")



  merged type ([EPSG code of the datasource.](model-defs-asset-properties-epsg-code-of-the-datasource.md))

  any of

  *   [Untitled integer in Item](model-defs-asset-properties-epsg-code-of-the-datasource-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-epsg-code-of-the-datasource-anyof-1.md "check type definition")





  `proj__wkt2`

  *   is optional

  *   Type: merged type ([PROJJSON object representing the Coordinate Reference System (CRS) that the proj:geometry and proj:bbox fields represent.](model-defs-asset-properties-projjson-object-representing-the-coordinate-reference-system-crs-that-the-projgeometry-and-projbbox-fields-represent.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-projjson-object-representing-the-coordinate-reference-system-crs-that-the-projgeometry-and-projbbox-fields-represent.md "airs_model#/$defs/Asset/properties/proj__wkt2")



  merged type ([PROJJSON object representing the Coordinate Reference System (CRS) that the proj:geometry and proj:bbox fields represent.](model-defs-asset-properties-projjson-object-representing-the-coordinate-reference-system-crs-that-the-projgeometry-and-projbbox-fields-represent.md))

  any of

  *   [Untitled string in Item](model-defs-asset-properties-projjson-object-representing-the-coordinate-reference-system-crs-that-the-projgeometry-and-projbbox-fields-represent-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-projjson-object-representing-the-coordinate-reference-system-crs-that-the-projgeometry-and-projbbox-fields-represent-anyof-1.md "check type definition")





  `proj__geometry`

  *   is optional

  *   Type: merged type ([Defines the footprint of this Item.](model-defs-asset-properties-defines-the-footprint-of-this-item.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-defines-the-footprint-of-this-item.md "airs_model#/$defs/Asset/properties/proj__geometry")



  merged type ([Defines the footprint of this Item.](model-defs-asset-properties-defines-the-footprint-of-this-item.md))

  any of

  *   [Untitled undefined type in Item](model-defs-asset-properties-defines-the-footprint-of-this-item-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-defines-the-footprint-of-this-item-anyof-1.md "check type definition")





  `proj__bbox`

  *   is optional

  *   Type: merged type ([Bounding box of the Item in the asset CRS in 2 or 3 dimensions.](model-defs-asset-properties-bounding-box-of-the-item-in-the-asset-crs-in-2-or-3-dimensions.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-bounding-box-of-the-item-in-the-asset-crs-in-2-or-3-dimensions.md "airs_model#/$defs/Asset/properties/proj__bbox")



  merged type ([Bounding box of the Item in the asset CRS in 2 or 3 dimensions.](model-defs-asset-properties-bounding-box-of-the-item-in-the-asset-crs-in-2-or-3-dimensions.md))

  any of

  *   [Untitled array in Item](model-defs-asset-properties-bounding-box-of-the-item-in-the-asset-crs-in-2-or-3-dimensions-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-bounding-box-of-the-item-in-the-asset-crs-in-2-or-3-dimensions-anyof-1.md "check type definition")





  `proj__centroid`

  *   is optional

  *   Type: merged type ([Coordinates representing the centroid of the Item (in lat/long).](model-defs-asset-properties-coordinates-representing-the-centroid-of-the-item-in-latlong.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-coordinates-representing-the-centroid-of-the-item-in-latlong.md "airs_model#/$defs/Asset/properties/proj__centroid")



  merged type ([Coordinates representing the centroid of the Item (in lat/long).](model-defs-asset-properties-coordinates-representing-the-centroid-of-the-item-in-latlong.md))

  any of

  *   [Untitled undefined type in Item](model-defs-asset-properties-coordinates-representing-the-centroid-of-the-item-in-latlong-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-coordinates-representing-the-centroid-of-the-item-in-latlong-anyof-1.md "check type definition")





  `proj__shape`

  *   is optional

  *   Type: merged type ([Number of pixels in Y and X directions for the default grid.](model-defs-asset-properties-number-of-pixels-in-y-and-x-directions-for-the-default-grid.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-number-of-pixels-in-y-and-x-directions-for-the-default-grid.md "airs_model#/$defs/Asset/properties/proj__shape")



  merged type ([Number of pixels in Y and X directions for the default grid.](model-defs-asset-properties-number-of-pixels-in-y-and-x-directions-for-the-default-grid.md))

  any of

  *   [Untitled array in Item](model-defs-asset-properties-number-of-pixels-in-y-and-x-directions-for-the-default-grid-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-number-of-pixels-in-y-and-x-directions-for-the-default-grid-anyof-1.md "check type definition")





  `proj__transform`

  *   is optional

  *   Type: merged type ([The affine transformation coefficients for the default grid.](model-defs-asset-properties-the-affine-transformation-coefficients-for-the-default-grid.md))

  *   cannot be null

  *   defined in: [Item](model-defs-asset-properties-the-affine-transformation-coefficients-for-the-default-grid.md "airs_model#/$defs/Asset/properties/proj__transform")



  merged type ([The affine transformation coefficients for the default grid.](model-defs-asset-properties-the-affine-transformation-coefficients-for-the-default-grid.md))

  any of

  *   [Untitled array in Item](model-defs-asset-properties-the-affine-transformation-coefficients-for-the-default-grid-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-asset-properties-the-affine-transformation-coefficients-for-the-default-grid-anyof-1.md "check type definition")



  Additional properties are allowed and do not have to follow a specific schema



  Reference this group by using

  ```json
  {"$ref":"airs_model#/$defs/Band"}
  ```

  | Property                                       | Type     | Required | Nullable       | Defined by                                                                                                                                                                                                                       |
  | :--------------------------------------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | [name](#name-1)                                | `string` | Required | cannot be null | [Item](model-defs-band-properties-the-name-of-the-band-eg-b01-b8-band2-red.md "airs_model#/$defs/Band/properties/name")                                                                                                          |
  | [common\_name](#common_name)                   | Merged   | Optional | cannot be null | [Item](model-defs-band-properties-the-name-commonly-used-to-refer-to-the-band-to-make-it-easier-to-search-for-bands-across-instruments-see-the-list-of-accepted-common-names.md "airs_model#/$defs/Band/properties/common_name") |
  | [description](#description-1)                  | Merged   | Optional | cannot be null | [Item](model-defs-band-properties-description-to-fully-explain-the-band-commonmark-029-syntax-may-be-used-for-rich-text-representation.md "airs_model#/$defs/Band/properties/description")                                       |
  | [center\_wavelength](#center_wavelength)       | Merged   | Optional | cannot be null | [Item](model-defs-band-properties-the-center-wavelength-of-the-band-in-micrometers-μm.md "airs_model#/$defs/Band/properties/center_wavelength")                                                                                  |
  | [full\_width\_half\_max](#full_width_half_max) | Merged   | Optional | cannot be null | [Item](model-defs-band-properties-full-width-at-half-maximum-fwhm-the-width-of-the-band-as-measured-at-half-the-maximum-transmission-in-micrometers-μm.md "airs_model#/$defs/Band/properties/full_width_half_max")               |
  | [solar\_illumination](#solar_illumination)     | Merged   | Optional | cannot be null | [Item](model-defs-band-properties-the-solar-illumination-of-the-band-as-measured-at-half-the-maximum-transmission-in-wm2micrometers.md "airs_model#/$defs/Band/properties/solar_illumination")                                   |
  | [quality\_indicators](#quality_indicators)     | Merged   | Optional | cannot be null | [Item](model-defs-band-properties-set-of-indicators-for-estimating-the-quality-of-the-datacube-variable-band.md "airs_model#/$defs/Band/properties/quality_indicators")                                                          |
  | Additional Properties                          | Any      | Optional | can be null    |                                                                                                                                                                                                                                  |





  `name`

  *   is required

  *   Type: `string` ([The name of the band (e.g., B01, B8, band2, red).](model-defs-band-properties-the-name-of-the-band-eg-b01-b8-band2-red.md))

  *   cannot be null

  *   defined in: [Item](model-defs-band-properties-the-name-of-the-band-eg-b01-b8-band2-red.md "airs_model#/$defs/Band/properties/name")



  `string` ([The name of the band (e.g., B01, B8, band2, red).](model-defs-band-properties-the-name-of-the-band-eg-b01-b8-band2-red.md))



  **maximum length**: the maximum number of characters for this string is: `300`





  `common_name`

  *   is optional

  *   Type: merged type ([The name commonly used to refer to the band to make it easier to search for bands across instruments. See the list of accepted common names.](model-defs-band-properties-the-name-commonly-used-to-refer-to-the-band-to-make-it-easier-to-search-for-bands-across-instruments-see-the-list-of-accepted-common-names.md))

  *   cannot be null

  *   defined in: [Item](model-defs-band-properties-the-name-commonly-used-to-refer-to-the-band-to-make-it-easier-to-search-for-bands-across-instruments-see-the-list-of-accepted-common-names.md "airs_model#/$defs/Band/properties/common_name")



  merged type ([The name commonly used to refer to the band to make it easier to search for bands across instruments. See the list of accepted common names.](model-defs-band-properties-the-name-commonly-used-to-refer-to-the-band-to-make-it-easier-to-search-for-bands-across-instruments-see-the-list-of-accepted-common-names.md))

  any of

  *   [Untitled string in Item](model-defs-band-properties-the-name-commonly-used-to-refer-to-the-band-to-make-it-easier-to-search-for-bands-across-instruments-see-the-list-of-accepted-common-names-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-band-properties-the-name-commonly-used-to-refer-to-the-band-to-make-it-easier-to-search-for-bands-across-instruments-see-the-list-of-accepted-common-names-anyof-1.md "check type definition")





  `description`

  *   is optional

  *   Type: merged type ([Description to fully explain the band. CommonMark 0.29 syntax MAY be used for rich text representation.](model-defs-band-properties-description-to-fully-explain-the-band-commonmark-029-syntax-may-be-used-for-rich-text-representation.md))

  *   cannot be null

  *   defined in: [Item](model-defs-band-properties-description-to-fully-explain-the-band-commonmark-029-syntax-may-be-used-for-rich-text-representation.md "airs_model#/$defs/Band/properties/description")



  merged type ([Description to fully explain the band. CommonMark 0.29 syntax MAY be used for rich text representation.](model-defs-band-properties-description-to-fully-explain-the-band-commonmark-029-syntax-may-be-used-for-rich-text-representation.md))

  any of

  *   [Untitled string in Item](model-defs-band-properties-description-to-fully-explain-the-band-commonmark-029-syntax-may-be-used-for-rich-text-representation-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-band-properties-description-to-fully-explain-the-band-commonmark-029-syntax-may-be-used-for-rich-text-representation-anyof-1.md "check type definition")





  `center_wavelength`

  *   is optional

  *   Type: merged type ([The center wavelength of the band, in micrometers (μm).](model-defs-band-properties-the-center-wavelength-of-the-band-in-micrometers-μm.md))

  *   cannot be null

  *   defined in: [Item](model-defs-band-properties-the-center-wavelength-of-the-band-in-micrometers-μm.md "airs_model#/$defs/Band/properties/center_wavelength")



  merged type ([The center wavelength of the band, in micrometers (μm).](model-defs-band-properties-the-center-wavelength-of-the-band-in-micrometers-μm.md))

  any of

  *   [Untitled number in Item](model-defs-band-properties-the-center-wavelength-of-the-band-in-micrometers-μm-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-band-properties-the-center-wavelength-of-the-band-in-micrometers-μm-anyof-1.md "check type definition")





  `full_width_half_max`

  *   is optional

  *   Type: merged type ([Full width at half maximum (FWHM). The width of the band, as measured at half the maximum transmission, in micrometers (μm).](model-defs-band-properties-full-width-at-half-maximum-fwhm-the-width-of-the-band-as-measured-at-half-the-maximum-transmission-in-micrometers-μm.md))

  *   cannot be null

  *   defined in: [Item](model-defs-band-properties-full-width-at-half-maximum-fwhm-the-width-of-the-band-as-measured-at-half-the-maximum-transmission-in-micrometers-μm.md "airs_model#/$defs/Band/properties/full_width_half_max")



  merged type ([Full width at half maximum (FWHM). The width of the band, as measured at half the maximum transmission, in micrometers (μm).](model-defs-band-properties-full-width-at-half-maximum-fwhm-the-width-of-the-band-as-measured-at-half-the-maximum-transmission-in-micrometers-μm.md))

  any of

  *   [Untitled number in Item](model-defs-band-properties-full-width-at-half-maximum-fwhm-the-width-of-the-band-as-measured-at-half-the-maximum-transmission-in-micrometers-μm-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-band-properties-full-width-at-half-maximum-fwhm-the-width-of-the-band-as-measured-at-half-the-maximum-transmission-in-micrometers-μm-anyof-1.md "check type definition")





  `solar_illumination`

  *   is optional

  *   Type: merged type ([The solar illumination of the band, as measured at half the maximum transmission, in W/m2/micrometers.](model-defs-band-properties-the-solar-illumination-of-the-band-as-measured-at-half-the-maximum-transmission-in-wm2micrometers.md))

  *   cannot be null

  *   defined in: [Item](model-defs-band-properties-the-solar-illumination-of-the-band-as-measured-at-half-the-maximum-transmission-in-wm2micrometers.md "airs_model#/$defs/Band/properties/solar_illumination")



  merged type ([The solar illumination of the band, as measured at half the maximum transmission, in W/m2/micrometers.](model-defs-band-properties-the-solar-illumination-of-the-band-as-measured-at-half-the-maximum-transmission-in-wm2micrometers.md))

  any of

  *   [Untitled number in Item](model-defs-band-properties-the-solar-illumination-of-the-band-as-measured-at-half-the-maximum-transmission-in-wm2micrometers-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-band-properties-the-solar-illumination-of-the-band-as-measured-at-half-the-maximum-transmission-in-wm2micrometers-anyof-1.md "check type definition")





  `quality_indicators`

  *   is optional

  *   Type: merged type ([Set of indicators for estimating the quality of the datacube variable (band).](model-defs-band-properties-set-of-indicators-for-estimating-the-quality-of-the-datacube-variable-band.md))

  *   cannot be null

  *   defined in: [Item](model-defs-band-properties-set-of-indicators-for-estimating-the-quality-of-the-datacube-variable-band.md "airs_model#/$defs/Band/properties/quality_indicators")



  merged type ([Set of indicators for estimating the quality of the datacube variable (band).](model-defs-band-properties-set-of-indicators-for-estimating-the-quality-of-the-datacube-variable-band.md))

  any of

  *   [Indicators](model-defs-indicators.md "check type definition")

  *   [Untitled null in Item](model-defs-band-properties-set-of-indicators-for-estimating-the-quality-of-the-datacube-variable-band-anyof-1.md "check type definition")



  Additional properties are allowed and do not have to follow a specific schema



  Reference this group by using

  ```json
  {"$ref":"airs_model#/$defs/DimensionType"}
  ```

  | Property | Type | Required | Nullable | Defined by |
  | :------- | :--- | :------- | :------- | :--------- |



  Reference this group by using

  ```json
  {"$ref":"airs_model#/$defs/Group"}
  ```

  | Property                                     | Type   | Required | Nullable       | Defined by                                                                                                                                                                                       |
  | :------------------------------------------- | :----- | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | [timestamp](#timestamp)                      | Merged | Optional | cannot be null | [Item](model-defs-group-properties-the-timestamp-of-this-temporal-group.md "airs_model#/$defs/Group/properties/timestamp")                                                                       |
  | [rasters](#rasters)                          | Merged | Optional | cannot be null | [Item](model-defs-group-properties-the-rasters-belonging-to-this-temporal-group.md "airs_model#/$defs/Group/properties/rasters")                                                                 |
  | [quality\_indicators](#quality_indicators-1) | Merged | Optional | cannot be null | [Item](model-defs-group-properties-set-of-indicators-for-estimating-the-quality-of-the-datacube-group-the-indicators-are-group-based.md "airs_model#/$defs/Group/properties/quality_indicators") |





  `timestamp`

  *   is optional

  *   Type: merged type ([The timestamp of this temporal group.](model-defs-group-properties-the-timestamp-of-this-temporal-group.md))

  *   cannot be null

  *   defined in: [Item](model-defs-group-properties-the-timestamp-of-this-temporal-group.md "airs_model#/$defs/Group/properties/timestamp")



  merged type ([The timestamp of this temporal group.](model-defs-group-properties-the-timestamp-of-this-temporal-group.md))

  any of

  *   [Untitled integer in Item](model-defs-group-properties-the-timestamp-of-this-temporal-group-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-group-properties-the-timestamp-of-this-temporal-group-anyof-1.md "check type definition")





  `rasters`

  *   is optional

  *   Type: merged type ([The rasters belonging to this temporal group.](model-defs-group-properties-the-rasters-belonging-to-this-temporal-group.md))

  *   cannot be null

  *   defined in: [Item](model-defs-group-properties-the-rasters-belonging-to-this-temporal-group.md "airs_model#/$defs/Group/properties/rasters")



  merged type ([The rasters belonging to this temporal group.](model-defs-group-properties-the-rasters-belonging-to-this-temporal-group.md))

  any of

  *   [Untitled array in Item](model-defs-group-properties-the-rasters-belonging-to-this-temporal-group-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-group-properties-the-rasters-belonging-to-this-temporal-group-anyof-1.md "check type definition")





  `quality_indicators`

  *   is optional

  *   Type: merged type ([Set of indicators for estimating the quality of the datacube group. The indicators are group based.](model-defs-group-properties-set-of-indicators-for-estimating-the-quality-of-the-datacube-group-the-indicators-are-group-based.md))

  *   cannot be null

  *   defined in: [Item](model-defs-group-properties-set-of-indicators-for-estimating-the-quality-of-the-datacube-group-the-indicators-are-group-based.md "airs_model#/$defs/Group/properties/quality_indicators")



  merged type ([Set of indicators for estimating the quality of the datacube group. The indicators are group based.](model-defs-group-properties-set-of-indicators-for-estimating-the-quality-of-the-datacube-group-the-indicators-are-group-based.md))

  any of

  *   [Indicators](model-defs-indicators.md "check type definition")

  *   [Untitled null in Item](model-defs-group-properties-set-of-indicators-for-estimating-the-quality-of-the-datacube-group-the-indicators-are-group-based-anyof-1.md "check type definition")



  Reference this group by using

  ```json
  {"$ref":"airs_model#/$defs/Indicators"}
  ```

  | Property                               | Type   | Required | Nullable       | Defined by                                                                                                                                                                                                                                                                                  |
  | :------------------------------------- | :----- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
  | [time\_compacity](#time_compacity)     | Merged | Optional | cannot be null | [Item](model-defs-indicators-properties-indicates-whether-the-temporal-extend-of-the-temporal-slices-groups-are-compact-or-not-compared-to-the-cube-temporal-extend-computed-as-follow-1-rangegroup-rasters--rangecube-rasters.md "airs_model#/$defs/Indicators/properties/time_compacity") |
  | [spatial\_coverage](#spatial_coverage) | Merged | Optional | cannot be null | [Item](model-defs-indicators-properties-indicates-the-proportion-of-the-region-of-interest-that-is-covered-by-the-input-rasters-computed-as-follow-areaintersectionunionrastersroi--arearoi.md "airs_model#/$defs/Indicators/properties/spatial_coverage")                                  |
  | [group\_lightness](#group_lightness)   | Merged | Optional | cannot be null | [Item](model-defs-indicators-properties-indicates-the-proportion-of-non-overlapping-regions-between-the-different-input-rasters-computed-as-follow-areaintersectionunionrastersroi--sumareaintersectionraster-roi.md "airs_model#/$defs/Indicators/properties/group_lightness")             |
  | [time\_regularity](#time_regularity)   | Merged | Optional | cannot be null | [Item](model-defs-indicators-properties-indicates-the-regularity-of-the-extends-between-the-temporal-slices-groups-computed-as-follow-1-stdinter-group-temporal-gapsavginter-group-temporal-gaps.md "airs_model#/$defs/Indicators/properties/time_regularity")                              |





  `time_compacity`

  *   is optional

  *   Type: merged type ([Indicates whether the temporal extend of the temporal slices (groups) are compact or not compared to the cube temporal extend. Computed as follow: 1-range(group rasters) / range(cube rasters).](model-defs-indicators-properties-indicates-whether-the-temporal-extend-of-the-temporal-slices-groups-are-compact-or-not-compared-to-the-cube-temporal-extend-computed-as-follow-1-rangegroup-rasters--rangecube-rasters.md))

  *   cannot be null

  *   defined in: [Item](model-defs-indicators-properties-indicates-whether-the-temporal-extend-of-the-temporal-slices-groups-are-compact-or-not-compared-to-the-cube-temporal-extend-computed-as-follow-1-rangegroup-rasters--rangecube-rasters.md "airs_model#/$defs/Indicators/properties/time_compacity")



  merged type ([Indicates whether the temporal extend of the temporal slices (groups) are compact or not compared to the cube temporal extend. Computed as follow: 1-range(group rasters) / range(cube rasters).](model-defs-indicators-properties-indicates-whether-the-temporal-extend-of-the-temporal-slices-groups-are-compact-or-not-compared-to-the-cube-temporal-extend-computed-as-follow-1-rangegroup-rasters--rangecube-rasters.md))

  any of

  *   [Untitled number in Item](model-defs-indicators-properties-indicates-whether-the-temporal-extend-of-the-temporal-slices-groups-are-compact-or-not-compared-to-the-cube-temporal-extend-computed-as-follow-1-rangegroup-rasters--rangecube-rasters-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-indicators-properties-indicates-whether-the-temporal-extend-of-the-temporal-slices-groups-are-compact-or-not-compared-to-the-cube-temporal-extend-computed-as-follow-1-rangegroup-rasters--rangecube-rasters-anyof-1.md "check type definition")





  `spatial_coverage`

  *   is optional

  *   Type: merged type ([Indicates the proportion of the region of interest that is covered by the input rasters. Computed as follow: area(intersection(union(rasters),roi)) / area(roi))](model-defs-indicators-properties-indicates-the-proportion-of-the-region-of-interest-that-is-covered-by-the-input-rasters-computed-as-follow-areaintersectionunionrastersroi--arearoi.md))

  *   cannot be null

  *   defined in: [Item](model-defs-indicators-properties-indicates-the-proportion-of-the-region-of-interest-that-is-covered-by-the-input-rasters-computed-as-follow-areaintersectionunionrastersroi--arearoi.md "airs_model#/$defs/Indicators/properties/spatial_coverage")



  merged type ([Indicates the proportion of the region of interest that is covered by the input rasters. Computed as follow: area(intersection(union(rasters),roi)) / area(roi))](model-defs-indicators-properties-indicates-the-proportion-of-the-region-of-interest-that-is-covered-by-the-input-rasters-computed-as-follow-areaintersectionunionrastersroi--arearoi.md))

  any of

  *   [Untitled number in Item](model-defs-indicators-properties-indicates-the-proportion-of-the-region-of-interest-that-is-covered-by-the-input-rasters-computed-as-follow-areaintersectionunionrastersroi--arearoi-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-indicators-properties-indicates-the-proportion-of-the-region-of-interest-that-is-covered-by-the-input-rasters-computed-as-follow-areaintersectionunionrastersroi--arearoi-anyof-1.md "check type definition")





  `group_lightness`

  *   is optional

  *   Type: merged type ([Indicates the proportion of non overlapping regions between the different input rasters. Computed as follow: area(intersection(union(rasters),roi)) / sum(area(intersection(raster, roi)))](model-defs-indicators-properties-indicates-the-proportion-of-non-overlapping-regions-between-the-different-input-rasters-computed-as-follow-areaintersectionunionrastersroi--sumareaintersectionraster-roi.md))

  *   cannot be null

  *   defined in: [Item](model-defs-indicators-properties-indicates-the-proportion-of-non-overlapping-regions-between-the-different-input-rasters-computed-as-follow-areaintersectionunionrastersroi--sumareaintersectionraster-roi.md "airs_model#/$defs/Indicators/properties/group_lightness")



  merged type ([Indicates the proportion of non overlapping regions between the different input rasters. Computed as follow: area(intersection(union(rasters),roi)) / sum(area(intersection(raster, roi)))](model-defs-indicators-properties-indicates-the-proportion-of-non-overlapping-regions-between-the-different-input-rasters-computed-as-follow-areaintersectionunionrastersroi--sumareaintersectionraster-roi.md))

  any of

  *   [Untitled number in Item](model-defs-indicators-properties-indicates-the-proportion-of-non-overlapping-regions-between-the-different-input-rasters-computed-as-follow-areaintersectionunionrastersroi--sumareaintersectionraster-roi-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-indicators-properties-indicates-the-proportion-of-non-overlapping-regions-between-the-different-input-rasters-computed-as-follow-areaintersectionunionrastersroi--sumareaintersectionraster-roi-anyof-1.md "check type definition")





  `time_regularity`

  *   is optional

  *   Type: merged type ([Indicates the regularity of the extends between the temporal slices (groups). Computed as follow: 1-std(inter group temporal gaps)/avg(inter group temporal gaps)](model-defs-indicators-properties-indicates-the-regularity-of-the-extends-between-the-temporal-slices-groups-computed-as-follow-1-stdinter-group-temporal-gapsavginter-group-temporal-gaps.md))

  *   cannot be null

  *   defined in: [Item](model-defs-indicators-properties-indicates-the-regularity-of-the-extends-between-the-temporal-slices-groups-computed-as-follow-1-stdinter-group-temporal-gapsavginter-group-temporal-gaps.md "airs_model#/$defs/Indicators/properties/time_regularity")



  merged type ([Indicates the regularity of the extends between the temporal slices (groups). Computed as follow: 1-std(inter group temporal gaps)/avg(inter group temporal gaps)](model-defs-indicators-properties-indicates-the-regularity-of-the-extends-between-the-temporal-slices-groups-computed-as-follow-1-stdinter-group-temporal-gapsavginter-group-temporal-gaps.md))

  any of

  *   [Untitled number in Item](model-defs-indicators-properties-indicates-the-regularity-of-the-extends-between-the-temporal-slices-groups-computed-as-follow-1-stdinter-group-temporal-gapsavginter-group-temporal-gaps-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-indicators-properties-indicates-the-regularity-of-the-extends-between-the-temporal-slices-groups-computed-as-follow-1-stdinter-group-temporal-gapsavginter-group-temporal-gaps-anyof-1.md "check type definition")



  Reference this group by using

  ```json
  {"$ref":"airs_model#/$defs/Properties"}
  ```

  | Property                                                                  | Type   | Required | Nullable       | Defined by                                                                                                                                                                                                                                                                                                               |
  | :------------------------------------------------------------------------ | :----- | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  | [datetime](#datetime)                                                     | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-datetime-associated-with-this-item-if-none-a-start_datetime-and-end_datetime-must-be-supplied.md "airs_model#/$defs/Properties/properties/datetime")                                                                                                                             |
  | [start\_datetime](#start_datetime)                                        | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-optional-start-datetime-part-of-common-metadata-this-value-will-override-any-start_datetime-key-in-properties.md "airs_model#/$defs/Properties/properties/start_datetime")                                                                                                       |
  | [end\_datetime](#end_datetime)                                            | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-optional-end-datetime-part-of-common-metadata-this-value-will-override-any-end_datetime-key-in-properties.md "airs_model#/$defs/Properties/properties/end_datetime")                                                                                                             |
  | [programme](#programme)                                                   | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-name-of-the-programme.md "airs_model#/$defs/Properties/properties/programme")                                                                                                                                                                                                    |
  | [constellation](#constellation)                                           | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-name-of-the-constellation.md "airs_model#/$defs/Properties/properties/constellation")                                                                                                                                                                                            |
  | [satellite](#satellite)                                                   | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-name-of-the-satellite.md "airs_model#/$defs/Properties/properties/satellite")                                                                                                                                                                                                    |
  | [platform](#platform)                                                     | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-name-of-the-satellite-platform.md "airs_model#/$defs/Properties/properties/platform")                                                                                                                                                                                            |
  | [instrument](#instrument)                                                 | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-name-of-the-instrument.md "airs_model#/$defs/Properties/properties/instrument")                                                                                                                                                                                                  |
  | [sensor](#sensor)                                                         | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-name-of-the-sensor.md "airs_model#/$defs/Properties/properties/sensor")                                                                                                                                                                                                          |
  | [sensor\_mode](#sensor_mode)                                              | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-mode-of-the-sensor-during-acquisition.md "airs_model#/$defs/Properties/properties/sensor_mode")                                                                                                                                                                                  |
  | [sensor\_type](#sensor_type)                                              | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-type-of-sensor.md "airs_model#/$defs/Properties/properties/sensor_type")                                                                                                                                                                                                         |
  | [annotations](#annotations)                                               | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-human-annotations-for-the-item.md "airs_model#/$defs/Properties/properties/annotations")                                                                                                                                                                                         |
  | [gsd](#gsd-1)                                                             | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-ground-sampling-distance-resolution.md "airs_model#/$defs/Properties/properties/gsd")                                                                                                                                                                                            |
  | [secondary\_id](#secondary_id)                                            | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-secondary-identifier.md "airs_model#/$defs/Properties/properties/secondary_id")                                                                                                                                                                                                  |
  | [data\_type](#data_type)                                                  | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-type-of-data.md "airs_model#/$defs/Properties/properties/data_type")                                                                                                                                                                                                             |
  | [item\_type](#item_type)                                                  | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-type-of-data-resourcetype.md "airs_model#/$defs/Properties/properties/item_type")                                                                                                                                                                                                |
  | [item\_format](#item_format)                                              | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-data-format-itemformat.md "airs_model#/$defs/Properties/properties/item_format")                                                                                                                                                                                                 |
  | [main\_asset\_format](#main_asset_format)                                 | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-data-format-of-the-main-asset-assetformat.md "airs_model#/$defs/Properties/properties/main_asset_format")                                                                                                                                                                        |
  | [main\_asset\_name](#main_asset_name)                                     | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-name-of-the-main-asset-assetformat.md "airs_model#/$defs/Properties/properties/main_asset_name")                                                                                                                                                                                 |
  | [observation\_type](#observation_type)                                    | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-type-of-observation-observationtype.md "airs_model#/$defs/Properties/properties/observation_type")                                                                                                                                                                               |
  | [data\_coverage](#data_coverage)                                          | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-estimate-of-data-cover.md "airs_model#/$defs/Properties/properties/data_coverage")                                                                                                                                                                                               |
  | [water\_coverage](#water_coverage)                                        | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-estimate-of-water-cover.md "airs_model#/$defs/Properties/properties/water_coverage")                                                                                                                                                                                             |
  | [locations](#locations)                                                   | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-list-of-locations-covered-by-the-item.md "airs_model#/$defs/Properties/properties/locations")                                                                                                                                                                                    |
  | [create\_datetime](#create_datetime)                                      | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-date-of-item-creation-in-the-catalog-managed-by-the-arlas-item-registration-service.md "airs_model#/$defs/Properties/properties/create_datetime")                                                                                                                                |
  | [update\_datetime](#update_datetime)                                      | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-update-date-of-the-item-in-the-catalog-managed-by-the-arlas-item-registration-service.md "airs_model#/$defs/Properties/properties/update_datetime")                                                                                                                              |
  | [view\_\_off\_nadir](#view__off_nadir)                                    | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-the-angle-from-the-sensor-between-nadir-straight-down-and-the-scene-center-measured-in-degrees-0-90.md "airs_model#/$defs/Properties/properties/view__off_nadir")                                                                                                                |
  | [view\_\_incidence\_angle](#view__incidence_angle)                        | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-the-incidence-angle-is-the-angle-between-the-vertical-normal-to-the-intercepting-surface-and-the-line-of-sight-back-to-the-satellite-at-the-scene-center-measured-in-degrees-0-90.md "airs_model#/$defs/Properties/properties/view__incidence_angle")                            |
  | [view\_\_azimuth](#view__azimuth)                                         | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-viewing-azimuth-angle-the-angle-measured-from-the-sub-satellite-point-point-on-the-ground-below-the-platform-between-the-scene-center-and-true-north-measured-clockwise-from-north-in-degrees-0-360.md "airs_model#/$defs/Properties/properties/view__azimuth")                  |
  | [view\_\_sun\_azimuth](#view__sun_azimuth)                                | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-sun-azimuth-angle-from-the-scene-center-point-on-the-ground-this-is-the-angle-between-truth-north-and-the-sun-measured-clockwise-in-degrees-0-360.md "airs_model#/$defs/Properties/properties/view__sun_azimuth")                                                                |
  | [view\_\_sun\_elevation](#view__sun_elevation)                            | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-sun-elevation-angle-the-angle-from-the-tangent-of-the-scene-center-point-to-the-sun-measured-from-the-horizon-in-degrees--90-90-negative-values-indicate-the-sun-is-below-the-horizon-eg-sun-elevation-of--10-.md "airs_model#/$defs/Properties/properties/view__sun_elevation") |
  | [storage\_\_requester\_pays](#storage__requester_pays-1)                  | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-is-the-data-requester-pays-or-is-it-data-managercloud-provider-pays-defaults-to-false-whether-the-requester-pays-for-accessing-assets.md "airs_model#/$defs/Properties/properties/storage__requester_pays")                                                                      |
  | [storage\_\_tier](#storage__tier-1)                                       | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-cloud-provider-storage-tiers-standard-glacier-etc.md "airs_model#/$defs/Properties/properties/storage__tier")                                                                                                                                                                    |
  | [storage\_\_platform](#storage__platform-1)                               | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-paas-solutions-alibaba-aws-azure-gcp-ibm-oracle-other.md "airs_model#/$defs/Properties/properties/storage__platform")                                                                                                                                                            |
  | [storage\_\_region](#storage__region-1)                                   | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-the-region-where-the-data-is-stored-relevant-to-speed-of-access-and-inter-region-egress-costs-as-defined-by-paas-provider.md "airs_model#/$defs/Properties/properties/storage__region")                                                                                          |
  | [eo\_\_cloud\_cover](#eo__cloud_cover)                                    | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-estimate-of-cloud-cover.md "airs_model#/$defs/Properties/properties/eo__cloud_cover")                                                                                                                                                                                            |
  | [eo\_\_snow\_cover](#eo__snow_cover)                                      | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-estimate-of-snow-and-ice-cover.md "airs_model#/$defs/Properties/properties/eo__snow_cover")                                                                                                                                                                                      |
  | [eo\_\_bands](#eo__bands-1)                                               | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-an-array-of-available-bands-where-each-object-is-a-band-object-if-given-requires-at-least-one-band.md "airs_model#/$defs/Properties/properties/eo__bands")                                                                                                                       |
  | [processing\_\_expression](#processing__expression)                       | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-an-expression-or-processing-chain-that-describes-how-the-data-has-been-processed-alternatively-you-can-also-link-to-a-processing-chain-with-the-relation-type-processing-expression-see-below.md "airs_model#/$defs/Properties/properties/processing__expression")               |
  | [processing\_\_lineage](#processing__lineage)                             | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-lineage-information-provided-as-free-text-information-about-the-how-observations-were-processed-or-models-that-were-used-to-create-the-resource-being-described-nasa-iso.md "airs_model#/$defs/Properties/properties/processing__lineage")                                       |
  | [processing\_\_level](#processing__level)                                 | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-the-name-commonly-used-to-refer-to-the-processing-level-to-make-it-easier-to-search-for-product-level-across-collections-or-items-the-short-name-must-be-used-only-l-not-level.md "airs_model#/$defs/Properties/properties/processing__level")                                   |
  | [processing\_\_facility](#processing__facility)                           | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-the-name-of-the-facility-that-produced-the-data-for-example-copernicus-s1-core-ground-segment---dpa-for-product-of-sentinel-1-satellites.md "airs_model#/$defs/Properties/properties/processing__facility")                                                                      |
  | [processing\_\_software](#processing__software)                           | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-a-dictionary-with-nameversion-for-keyvalue-describing-one-or-more-softwares-that-produced-the-data.md "airs_model#/$defs/Properties/properties/processing__software")                                                                                                            |
  | [dc3\_\_quality\_indicators](#dc3__quality_indicators)                    | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-set-of-indicators-for-estimating-the-quality-of-the-datacube-based-on-the-composition-the-indicators-are-group-based-a-cube-indicator-is-the-product-of-its-corresponding-group-indicator.md "airs_model#/$defs/Properties/properties/dc3__quality_indicators")                  |
  | [dc3\_\_composition](#dc3__composition)                                   | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-list-of-raster-groups-used-for-elaborating-the-cube-temporal-slices.md "airs_model#/$defs/Properties/properties/dc3__composition")                                                                                                                                               |
  | [dc3\_\_number\_of\_chunks](#dc3__number_of_chunks)                       | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-number-of-chunks-if-zarr-or-similar-partitioned-format-within-the-cube.md "airs_model#/$defs/Properties/properties/dc3__number_of_chunks")                                                                                                                                       |
  | [dc3\_\_chunk\_weight](#dc3__chunk_weight)                                | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-weight-of-a-chunk-number-of-bytes.md "airs_model#/$defs/Properties/properties/dc3__chunk_weight")                                                                                                                                                                                |
  | [dc3\_\_fill\_ratio](#dc3__fill_ratio)                                    | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-1-the-cube-is-full-0-the-cube-is-empty-in-between-the-cube-is-partially-filled.md "airs_model#/$defs/Properties/properties/dc3__fill_ratio")                                                                                                                                     |
  | [cube\_\_dimensions](#cube__dimensions)                                   | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-uniquely-named-dimensions-of-the-datacube.md "airs_model#/$defs/Properties/properties/cube__dimensions")                                                                                                                                                                         |
  | [cube\_\_variables](#cube__variables)                                     | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-uniquely-named-variables-of-the-datacube.md "airs_model#/$defs/Properties/properties/cube__variables")                                                                                                                                                                           |
  | [acq\_\_acquisition\_mode](#acq__acquisition_mode)                        | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-the-name-of-the-acquisition-mode.md "airs_model#/$defs/Properties/properties/acq__acquisition_mode")                                                                                                                                                                             |
  | [acq\_\_acquisition\_orbit\_direction](#acq__acquisition_orbit_direction) | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-acquisition-orbit-direction-ascending-or-descending.md "airs_model#/$defs/Properties/properties/acq__acquisition_orbit_direction")                                                                                                                                               |
  | [acq\_\_acquisition\_type](#acq__acquisition_type)                        | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-acquisition-type-strip.md "airs_model#/$defs/Properties/properties/acq__acquisition_type")                                                                                                                                                                                       |
  | [acq\_\_acquisition\_orbit](#acq__acquisition_orbit)                      | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-acquisition-orbit.md "airs_model#/$defs/Properties/properties/acq__acquisition_orbit")                                                                                                                                                                                           |
  | [acq\_\_across\_track](#acq__across_track)                                | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-across-track-angle.md "airs_model#/$defs/Properties/properties/acq__across_track")                                                                                                                                                                                               |
  | [acq\_\_along\_track](#acq__along_track)                                  | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-along-track-angle.md "airs_model#/$defs/Properties/properties/acq__along_track")                                                                                                                                                                                                 |
  | [acq\_\_archiving\_date](#acq__archiving_date)                            | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-archiving-date.md "airs_model#/$defs/Properties/properties/acq__archiving_date")                                                                                                                                                                                                 |
  | [acq\_\_download\_orbit](#acq__download_orbit)                            | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-download-orbit.md "airs_model#/$defs/Properties/properties/acq__download_orbit")                                                                                                                                                                                                 |
  | [acq\_\_request\_id](#acq__request_id)                                    | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-original-request-identifier.md "airs_model#/$defs/Properties/properties/acq__request_id")                                                                                                                                                                                        |
  | [acq\_\_quality\_average](#acq__quality_average)                          | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-quality-average.md "airs_model#/$defs/Properties/properties/acq__quality_average")                                                                                                                                                                                               |
  | [acq\_\_quality\_computation](#acq__quality_computation)                  | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-quality-computation.md "airs_model#/$defs/Properties/properties/acq__quality_computation")                                                                                                                                                                                       |
  | [acq\_\_receiving\_station](#acq__receiving_station)                      | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-receiving-station.md "airs_model#/$defs/Properties/properties/acq__receiving_station")                                                                                                                                                                                           |
  | [acq\_\_reception\_date](#acq__reception_date)                            | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-reception-date.md "airs_model#/$defs/Properties/properties/acq__reception_date")                                                                                                                                                                                                 |
  | [acq\_\_spectral\_mode](#acq__spectral_mode)                              | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-spectral-mode.md "airs_model#/$defs/Properties/properties/acq__spectral_mode")                                                                                                                                                                                                   |
  | [sar\_\_instrument\_mode](#sar__instrument_mode-1)                        | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-the-name-of-the-sensor-acquisition-mode-that-is-commonly-used-this-should-be-the-short-name-if-available-for-example-wv-for-wave-mode-of-sentinel-1-and-envisat-asar-satellites.md "airs_model#/$defs/Properties/properties/sar__instrument_mode")                               |
  | [sar\_\_frequency\_band](#sar__frequency_band-1)                          | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-the-common-name-for-the-frequency-band-to-make-it-easier-to-search-for-bands-across-instruments-see-section-common-frequency-band-names-for-a-list-of-accepted-names.md "airs_model#/$defs/Properties/properties/sar__frequency_band")                                           |
  | [sar\_\_center\_frequency](#sar__center_frequency-1)                      | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-the-center-frequency-of-the-instrument-in-gigahertz-ghz.md "airs_model#/$defs/Properties/properties/sar__center_frequency")                                                                                                                                                      |
  | [sar\_\_polarizations](#sar__polarizations-1)                             | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-any-combination-of-polarizations.md "airs_model#/$defs/Properties/properties/sar__polarizations")                                                                                                                                                                                |
  | [sar\_\_product\_type](#sar__product_type-1)                              | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-the-product-type-for-example-ssc-mgd-or-sgc.md "airs_model#/$defs/Properties/properties/sar__product_type")                                                                                                                                                                      |
  | [sar\_\_resolution\_range](#sar__resolution_range-1)                      | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-the-range-resolution-which-is-the-maximum-ability-to-distinguish-two-adjacent-targets-perpendicular-to-the-flight-path-in-meters-m.md "airs_model#/$defs/Properties/properties/sar__resolution_range")                                                                           |
  | [sar\_\_resolution\_azimuth](#sar__resolution_azimuth-1)                  | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-the-azimuth-resolution-which-is-the-maximum-ability-to-distinguish-two-adjacent-targets-parallel-to-the-flight-path-in-meters-m.md "airs_model#/$defs/Properties/properties/sar__resolution_azimuth")                                                                            |
  | [sar\_\_pixel\_spacing\_range](#sar__pixel_spacing_range-1)               | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-the-range-pixel-spacing-which-is-the-distance-between-adjacent-pixels-perpendicular-to-the-flight-path-in-meters-m-strongly-recommended-to-be-specified-for-products-of-type-grd.md "airs_model#/$defs/Properties/properties/sar__pixel_spacing_range")                          |
  | [sar\_\_pixel\_spacing\_azimuth](#sar__pixel_spacing_azimuth-1)           | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-the-azimuth-pixel-spacing-which-is-the-distance-between-adjacent-pixels-parallel-to-the-flight-path-in-meters-m-strongly-recommended-to-be-specified-for-products-of-type-grd.md "airs_model#/$defs/Properties/properties/sar__pixel_spacing_azimuth")                           |
  | [sar\_\_looks\_range](#sar__looks_range-1)                                | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-number-of-range-looks-which-is-the-number-of-groups-of-signal-samples-looks-perpendicular-to-the-flight-path.md "airs_model#/$defs/Properties/properties/sar__looks_range")                                                                                                      |
  | [sar\_\_looks\_azimuth](#sar__looks_azimuth-1)                            | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-number-of-azimuth-looks-which-is-the-number-of-groups-of-signal-samples-looks-parallel-to-the-flight-path.md "airs_model#/$defs/Properties/properties/sar__looks_azimuth")                                                                                                       |
  | [sar\_\_looks\_equivalent\_number](#sar__looks_equivalent_number-1)       | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-the-equivalent-number-of-looks-enl.md "airs_model#/$defs/Properties/properties/sar__looks_equivalent_number")                                                                                                                                                                    |
  | [sar\_\_observation\_direction](#sar__observation_direction-1)            | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-antenna-pointing-direction-relative-to-the-flight-trajectory-of-the-satellite-either-left-or-right.md "airs_model#/$defs/Properties/properties/sar__observation_direction")                                                                                                      |
  | [proj\_\_epsg](#proj__epsg-1)                                             | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-epsg-code-of-the-datasource.md "airs_model#/$defs/Properties/properties/proj__epsg")                                                                                                                                                                                             |
  | [proj\_\_wkt2](#proj__wkt2-1)                                             | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-projjson-object-representing-the-coordinate-reference-system-crs-that-the-projgeometry-and-projbbox-fields-represent.md "airs_model#/$defs/Properties/properties/proj__wkt2")                                                                                                    |
  | [proj\_\_geometry](#proj__geometry-1)                                     | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-defines-the-footprint-of-this-item.md "airs_model#/$defs/Properties/properties/proj__geometry")                                                                                                                                                                                  |
  | [proj\_\_bbox](#proj__bbox-1)                                             | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-bounding-box-of-the-item-in-the-asset-crs-in-2-or-3-dimensions.md "airs_model#/$defs/Properties/properties/proj__bbox")                                                                                                                                                          |
  | [proj\_\_centroid](#proj__centroid-1)                                     | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-coordinates-representing-the-centroid-of-the-item-in-latlong.md "airs_model#/$defs/Properties/properties/proj__centroid")                                                                                                                                                        |
  | [proj\_\_shape](#proj__shape-1)                                           | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-number-of-pixels-in-y-and-x-directions-for-the-default-grid.md "airs_model#/$defs/Properties/properties/proj__shape")                                                                                                                                                            |
  | [proj\_\_transform](#proj__transform-1)                                   | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-the-affine-transformation-coefficients-for-the-default-grid.md "airs_model#/$defs/Properties/properties/proj__transform")                                                                                                                                                        |
  | [generated\_\_has\_overview](#generated__has_overview)                    | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-whether-the-item-has-an-overview-or-not.md "airs_model#/$defs/Properties/properties/generated__has_overview")                                                                                                                                                                    |
  | [generated\_\_has\_thumbnail](#generated__has_thumbnail)                  | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-whether-the-item-has-a-thumbnail-or-not.md "airs_model#/$defs/Properties/properties/generated__has_thumbnail")                                                                                                                                                                   |
  | [generated\_\_has\_metadata](#generated__has_metadata)                    | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-whether-the-item-has-a-metadata-file-or-not.md "airs_model#/$defs/Properties/properties/generated__has_metadata")                                                                                                                                                                |
  | [generated\_\_has\_data](#generated__has_data)                            | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-whether-the-item-has-a-data-file-or-not.md "airs_model#/$defs/Properties/properties/generated__has_data")                                                                                                                                                                        |
  | [generated\_\_has\_cog](#generated__has_cog)                              | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-whether-the-item-has-a-cog-or-not.md "airs_model#/$defs/Properties/properties/generated__has_cog")                                                                                                                                                                               |
  | [generated\_\_has\_zarr](#generated__has_zarr)                            | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-whether-the-item-has-a-zarr-or-not.md "airs_model#/$defs/Properties/properties/generated__has_zarr")                                                                                                                                                                             |
  | [generated\_\_date\_keywords](#generated__date_keywords)                  | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-a-list-of-keywords-indicating-clues-on-the-date.md "airs_model#/$defs/Properties/properties/generated__date_keywords")                                                                                                                                                           |
  | [generated\_\_day\_of\_week](#generated__day_of_week)                     | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-day-of-week.md "airs_model#/$defs/Properties/properties/generated__day_of_week")                                                                                                                                                                                                 |
  | [generated\_\_day\_of\_year](#generated__day_of_year)                     | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-day-of-year.md "airs_model#/$defs/Properties/properties/generated__day_of_year")                                                                                                                                                                                                 |
  | [generated\_\_hour\_of\_day](#generated__hour_of_day)                     | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-hour-of-day.md "airs_model#/$defs/Properties/properties/generated__hour_of_day")                                                                                                                                                                                                 |
  | [generated\_\_minute\_of\_day](#generated__minute_of_day)                 | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-minute-of-day.md "airs_model#/$defs/Properties/properties/generated__minute_of_day")                                                                                                                                                                                             |
  | [generated\_\_month](#generated__month)                                   | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-month.md "airs_model#/$defs/Properties/properties/generated__month")                                                                                                                                                                                                             |
  | [generated\_\_year](#generated__year)                                     | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-year.md "airs_model#/$defs/Properties/properties/generated__year")                                                                                                                                                                                                               |
  | [generated\_\_season](#generated__season)                                 | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-season.md "airs_model#/$defs/Properties/properties/generated__season")                                                                                                                                                                                                           |
  | [generated\_\_tltrbrbl](#generated__tltrbrbl)                             | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-the-coordinates-of-the-top-left-top-right-bottom-right-bottom-left-corners-of-the-item.md "airs_model#/$defs/Properties/properties/generated__tltrbrbl")                                                                                                                         |
  | [generated\_\_band\_common\_names](#generated__band_common_names)         | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-list-of-the-band-common-names.md "airs_model#/$defs/Properties/properties/generated__band_common_names")                                                                                                                                                                         |
  | [generated\_\_band\_names](#generated__band_names)                        | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-list-of-the-band-names.md "airs_model#/$defs/Properties/properties/generated__band_names")                                                                                                                                                                                       |
  | [generated\_\_geohash2](#generated__geohash2)                             | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-geohash-on-the-first-two-characters.md "airs_model#/$defs/Properties/properties/generated__geohash2")                                                                                                                                                                            |
  | [generated\_\_geohash3](#generated__geohash3)                             | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-geohash-on-the-first-three-characters.md "airs_model#/$defs/Properties/properties/generated__geohash3")                                                                                                                                                                          |
  | [generated\_\_geohash4](#generated__geohash4)                             | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-geohash-on-the-first-four-characters.md "airs_model#/$defs/Properties/properties/generated__geohash4")                                                                                                                                                                           |
  | [generated\_\_geohash5](#generated__geohash5)                             | Merged | Optional | cannot be null | [Item](model-defs-properties-properties-geohash-on-the-first-five-characters.md "airs_model#/$defs/Properties/properties/generated__geohash5")                                                                                                                                                                           |
  | Additional Properties                                                     | Any    | Optional | can be null    |                                                                                                                                                                                                                                                                                                                          |





  `datetime`

  *   is optional

  *   Type: merged type ([datetime associated with this item. If None, a start\_datetime and end\_datetime must be supplied.](model-defs-properties-properties-datetime-associated-with-this-item-if-none-a-start_datetime-and-end_datetime-must-be-supplied.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-datetime-associated-with-this-item-if-none-a-start_datetime-and-end_datetime-must-be-supplied.md "airs_model#/$defs/Properties/properties/datetime")



  merged type ([datetime associated with this item. If None, a start\_datetime and end\_datetime must be supplied.](model-defs-properties-properties-datetime-associated-with-this-item-if-none-a-start_datetime-and-end_datetime-must-be-supplied.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-datetime-associated-with-this-item-if-none-a-start_datetime-and-end_datetime-must-be-supplied-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-datetime-associated-with-this-item-if-none-a-start_datetime-and-end_datetime-must-be-supplied-anyof-1.md "check type definition")





  `start_datetime`

  *   is optional

  *   Type: merged type ([Optional start datetime, part of common metadata. This value will override any start\_datetime key in properties.](model-defs-properties-properties-optional-start-datetime-part-of-common-metadata-this-value-will-override-any-start_datetime-key-in-properties.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-optional-start-datetime-part-of-common-metadata-this-value-will-override-any-start_datetime-key-in-properties.md "airs_model#/$defs/Properties/properties/start_datetime")



  merged type ([Optional start datetime, part of common metadata. This value will override any start\_datetime key in properties.](model-defs-properties-properties-optional-start-datetime-part-of-common-metadata-this-value-will-override-any-start_datetime-key-in-properties.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-optional-start-datetime-part-of-common-metadata-this-value-will-override-any-start_datetime-key-in-properties-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-optional-start-datetime-part-of-common-metadata-this-value-will-override-any-start_datetime-key-in-properties-anyof-1.md "check type definition")





  `end_datetime`

  *   is optional

  *   Type: merged type ([Optional end datetime, part of common metadata. This value will override any end\_datetime key in properties.](model-defs-properties-properties-optional-end-datetime-part-of-common-metadata-this-value-will-override-any-end_datetime-key-in-properties.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-optional-end-datetime-part-of-common-metadata-this-value-will-override-any-end_datetime-key-in-properties.md "airs_model#/$defs/Properties/properties/end_datetime")



  merged type ([Optional end datetime, part of common metadata. This value will override any end\_datetime key in properties.](model-defs-properties-properties-optional-end-datetime-part-of-common-metadata-this-value-will-override-any-end_datetime-key-in-properties.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-optional-end-datetime-part-of-common-metadata-this-value-will-override-any-end_datetime-key-in-properties-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-optional-end-datetime-part-of-common-metadata-this-value-will-override-any-end_datetime-key-in-properties-anyof-1.md "check type definition")





  `programme`

  *   is optional

  *   Type: merged type ([Name of the programme](model-defs-properties-properties-name-of-the-programme.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-name-of-the-programme.md "airs_model#/$defs/Properties/properties/programme")



  merged type ([Name of the programme](model-defs-properties-properties-name-of-the-programme.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-name-of-the-programme-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-name-of-the-programme-anyof-1.md "check type definition")





  `constellation`

  *   is optional

  *   Type: merged type ([Name of the constellation](model-defs-properties-properties-name-of-the-constellation.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-name-of-the-constellation.md "airs_model#/$defs/Properties/properties/constellation")



  merged type ([Name of the constellation](model-defs-properties-properties-name-of-the-constellation.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-name-of-the-constellation-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-name-of-the-constellation-anyof-1.md "check type definition")





  `satellite`

  *   is optional

  *   Type: merged type ([Name of the satellite](model-defs-properties-properties-name-of-the-satellite.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-name-of-the-satellite.md "airs_model#/$defs/Properties/properties/satellite")



  merged type ([Name of the satellite](model-defs-properties-properties-name-of-the-satellite.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-name-of-the-satellite-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-name-of-the-satellite-anyof-1.md "check type definition")





  `platform`

  *   is optional

  *   Type: merged type ([Name of the satellite platform](model-defs-properties-properties-name-of-the-satellite-platform.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-name-of-the-satellite-platform.md "airs_model#/$defs/Properties/properties/platform")



  merged type ([Name of the satellite platform](model-defs-properties-properties-name-of-the-satellite-platform.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-name-of-the-satellite-platform-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-name-of-the-satellite-platform-anyof-1.md "check type definition")





  `instrument`

  *   is optional

  *   Type: merged type ([Name of the instrument](model-defs-properties-properties-name-of-the-instrument.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-name-of-the-instrument.md "airs_model#/$defs/Properties/properties/instrument")



  merged type ([Name of the instrument](model-defs-properties-properties-name-of-the-instrument.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-name-of-the-instrument-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-name-of-the-instrument-anyof-1.md "check type definition")





  `sensor`

  *   is optional

  *   Type: merged type ([Name of the sensor](model-defs-properties-properties-name-of-the-sensor.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-name-of-the-sensor.md "airs_model#/$defs/Properties/properties/sensor")



  merged type ([Name of the sensor](model-defs-properties-properties-name-of-the-sensor.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-name-of-the-sensor-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-name-of-the-sensor-anyof-1.md "check type definition")





  `sensor_mode`

  *   is optional

  *   Type: merged type ([Mode of the sensor during acquisition](model-defs-properties-properties-mode-of-the-sensor-during-acquisition.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-mode-of-the-sensor-during-acquisition.md "airs_model#/$defs/Properties/properties/sensor_mode")



  merged type ([Mode of the sensor during acquisition](model-defs-properties-properties-mode-of-the-sensor-during-acquisition.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-mode-of-the-sensor-during-acquisition-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-mode-of-the-sensor-during-acquisition-anyof-1.md "check type definition")





  `sensor_type`

  *   is optional

  *   Type: merged type ([Type of sensor](model-defs-properties-properties-type-of-sensor.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-type-of-sensor.md "airs_model#/$defs/Properties/properties/sensor_type")



  merged type ([Type of sensor](model-defs-properties-properties-type-of-sensor.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-type-of-sensor-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-type-of-sensor-anyof-1.md "check type definition")





  `annotations`

  *   is optional

  *   Type: merged type ([Human annotations for the item](model-defs-properties-properties-human-annotations-for-the-item.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-human-annotations-for-the-item.md "airs_model#/$defs/Properties/properties/annotations")



  merged type ([Human annotations for the item](model-defs-properties-properties-human-annotations-for-the-item.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-human-annotations-for-the-item-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-human-annotations-for-the-item-anyof-1.md "check type definition")





  `gsd`

  *   is optional

  *   Type: merged type ([Ground Sampling Distance (resolution)](model-defs-properties-properties-ground-sampling-distance-resolution.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-ground-sampling-distance-resolution.md "airs_model#/$defs/Properties/properties/gsd")



  merged type ([Ground Sampling Distance (resolution)](model-defs-properties-properties-ground-sampling-distance-resolution.md))

  any of

  *   [Untitled number in Item](model-defs-properties-properties-ground-sampling-distance-resolution-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-ground-sampling-distance-resolution-anyof-1.md "check type definition")





  `secondary_id`

  *   is optional

  *   Type: merged type ([Secondary identifier](model-defs-properties-properties-secondary-identifier.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-secondary-identifier.md "airs_model#/$defs/Properties/properties/secondary_id")



  merged type ([Secondary identifier](model-defs-properties-properties-secondary-identifier.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-secondary-identifier-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-secondary-identifier-anyof-1.md "check type definition")





  `data_type`

  *   is optional

  *   Type: merged type ([Type of data](model-defs-properties-properties-type-of-data.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-type-of-data.md "airs_model#/$defs/Properties/properties/data_type")



  merged type ([Type of data](model-defs-properties-properties-type-of-data.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-type-of-data-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-type-of-data-anyof-1.md "check type definition")





  `item_type`

  *   is optional

  *   Type: merged type ([Type of data (ResourceType)](model-defs-properties-properties-type-of-data-resourcetype.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-type-of-data-resourcetype.md "airs_model#/$defs/Properties/properties/item_type")



  merged type ([Type of data (ResourceType)](model-defs-properties-properties-type-of-data-resourcetype.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-type-of-data-resourcetype-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-type-of-data-resourcetype-anyof-1.md "check type definition")





  `item_format`

  *   is optional

  *   Type: merged type ([Data format (ItemFormat)](model-defs-properties-properties-data-format-itemformat.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-data-format-itemformat.md "airs_model#/$defs/Properties/properties/item_format")



  merged type ([Data format (ItemFormat)](model-defs-properties-properties-data-format-itemformat.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-data-format-itemformat-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-data-format-itemformat-anyof-1.md "check type definition")





  `main_asset_format`

  *   is optional

  *   Type: merged type ([Data format of the main asset (AssetFormat)](model-defs-properties-properties-data-format-of-the-main-asset-assetformat.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-data-format-of-the-main-asset-assetformat.md "airs_model#/$defs/Properties/properties/main_asset_format")



  merged type ([Data format of the main asset (AssetFormat)](model-defs-properties-properties-data-format-of-the-main-asset-assetformat.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-data-format-of-the-main-asset-assetformat-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-data-format-of-the-main-asset-assetformat-anyof-1.md "check type definition")





  `main_asset_name`

  *   is optional

  *   Type: merged type ([Name of the main asset (AssetFormat)](model-defs-properties-properties-name-of-the-main-asset-assetformat.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-name-of-the-main-asset-assetformat.md "airs_model#/$defs/Properties/properties/main_asset_name")



  merged type ([Name of the main asset (AssetFormat)](model-defs-properties-properties-name-of-the-main-asset-assetformat.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-name-of-the-main-asset-assetformat-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-name-of-the-main-asset-assetformat-anyof-1.md "check type definition")





  `observation_type`

  *   is optional

  *   Type: merged type ([Type of observation (ObservationType)](model-defs-properties-properties-type-of-observation-observationtype.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-type-of-observation-observationtype.md "airs_model#/$defs/Properties/properties/observation_type")



  merged type ([Type of observation (ObservationType)](model-defs-properties-properties-type-of-observation-observationtype.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-type-of-observation-observationtype-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-type-of-observation-observationtype-anyof-1.md "check type definition")





  `data_coverage`

  *   is optional

  *   Type: merged type ([Estimate of data cover](model-defs-properties-properties-estimate-of-data-cover.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-estimate-of-data-cover.md "airs_model#/$defs/Properties/properties/data_coverage")



  merged type ([Estimate of data cover](model-defs-properties-properties-estimate-of-data-cover.md))

  any of

  *   [Untitled number in Item](model-defs-properties-properties-estimate-of-data-cover-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-estimate-of-data-cover-anyof-1.md "check type definition")





  `water_coverage`

  *   is optional

  *   Type: merged type ([Estimate of water cover](model-defs-properties-properties-estimate-of-water-cover.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-estimate-of-water-cover.md "airs_model#/$defs/Properties/properties/water_coverage")



  merged type ([Estimate of water cover](model-defs-properties-properties-estimate-of-water-cover.md))

  any of

  *   [Untitled number in Item](model-defs-properties-properties-estimate-of-water-cover-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-estimate-of-water-cover-anyof-1.md "check type definition")





  `locations`

  *   is optional

  *   Type: merged type ([List of locations covered by the item](model-defs-properties-properties-list-of-locations-covered-by-the-item.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-list-of-locations-covered-by-the-item.md "airs_model#/$defs/Properties/properties/locations")



  merged type ([List of locations covered by the item](model-defs-properties-properties-list-of-locations-covered-by-the-item.md))

  any of

  *   [Untitled array in Item](model-defs-properties-properties-list-of-locations-covered-by-the-item-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-list-of-locations-covered-by-the-item-anyof-1.md "check type definition")





  `create_datetime`

  *   is optional

  *   Type: merged type ([Date of item creation in the catalog, managed by the ARLAS Item Registration Service](model-defs-properties-properties-date-of-item-creation-in-the-catalog-managed-by-the-arlas-item-registration-service.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-date-of-item-creation-in-the-catalog-managed-by-the-arlas-item-registration-service.md "airs_model#/$defs/Properties/properties/create_datetime")



  merged type ([Date of item creation in the catalog, managed by the ARLAS Item Registration Service](model-defs-properties-properties-date-of-item-creation-in-the-catalog-managed-by-the-arlas-item-registration-service.md))

  any of

  *   [Untitled integer in Item](model-defs-properties-properties-date-of-item-creation-in-the-catalog-managed-by-the-arlas-item-registration-service-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-date-of-item-creation-in-the-catalog-managed-by-the-arlas-item-registration-service-anyof-1.md "check type definition")





  `update_datetime`

  *   is optional

  *   Type: merged type ([Update date of the item in the catalog, managed by the ARLAS Item Registration Service](model-defs-properties-properties-update-date-of-the-item-in-the-catalog-managed-by-the-arlas-item-registration-service.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-update-date-of-the-item-in-the-catalog-managed-by-the-arlas-item-registration-service.md "airs_model#/$defs/Properties/properties/update_datetime")



  merged type ([Update date of the item in the catalog, managed by the ARLAS Item Registration Service](model-defs-properties-properties-update-date-of-the-item-in-the-catalog-managed-by-the-arlas-item-registration-service.md))

  any of

  *   [Untitled integer in Item](model-defs-properties-properties-update-date-of-the-item-in-the-catalog-managed-by-the-arlas-item-registration-service-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-update-date-of-the-item-in-the-catalog-managed-by-the-arlas-item-registration-service-anyof-1.md "check type definition")





  `view__off_nadir`

  *   is optional

  *   Type: merged type ([The angle from the sensor between nadir (straight down) and the scene center. Measured in degrees (0-90).](model-defs-properties-properties-the-angle-from-the-sensor-between-nadir-straight-down-and-the-scene-center-measured-in-degrees-0-90.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-the-angle-from-the-sensor-between-nadir-straight-down-and-the-scene-center-measured-in-degrees-0-90.md "airs_model#/$defs/Properties/properties/view__off_nadir")



  merged type ([The angle from the sensor between nadir (straight down) and the scene center. Measured in degrees (0-90).](model-defs-properties-properties-the-angle-from-the-sensor-between-nadir-straight-down-and-the-scene-center-measured-in-degrees-0-90.md))

  any of

  *   [Untitled number in Item](model-defs-properties-properties-the-angle-from-the-sensor-between-nadir-straight-down-and-the-scene-center-measured-in-degrees-0-90-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-the-angle-from-the-sensor-between-nadir-straight-down-and-the-scene-center-measured-in-degrees-0-90-anyof-1.md "check type definition")





  `view__incidence_angle`

  *   is optional

  *   Type: merged type ([The incidence angle is the angle between the vertical (normal) to the intercepting surface and the line of sight back to the satellite at the scene center. Measured in degrees (0-90).](model-defs-properties-properties-the-incidence-angle-is-the-angle-between-the-vertical-normal-to-the-intercepting-surface-and-the-line-of-sight-back-to-the-satellite-at-the-scene-center-measured-in-degrees-0-90.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-the-incidence-angle-is-the-angle-between-the-vertical-normal-to-the-intercepting-surface-and-the-line-of-sight-back-to-the-satellite-at-the-scene-center-measured-in-degrees-0-90.md "airs_model#/$defs/Properties/properties/view__incidence_angle")



  merged type ([The incidence angle is the angle between the vertical (normal) to the intercepting surface and the line of sight back to the satellite at the scene center. Measured in degrees (0-90).](model-defs-properties-properties-the-incidence-angle-is-the-angle-between-the-vertical-normal-to-the-intercepting-surface-and-the-line-of-sight-back-to-the-satellite-at-the-scene-center-measured-in-degrees-0-90.md))

  any of

  *   [Untitled number in Item](model-defs-properties-properties-the-incidence-angle-is-the-angle-between-the-vertical-normal-to-the-intercepting-surface-and-the-line-of-sight-back-to-the-satellite-at-the-scene-center-measured-in-degrees-0-90-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-the-incidence-angle-is-the-angle-between-the-vertical-normal-to-the-intercepting-surface-and-the-line-of-sight-back-to-the-satellite-at-the-scene-center-measured-in-degrees-0-90-anyof-1.md "check type definition")





  `view__azimuth`

  *   is optional

  *   Type: merged type ([Viewing azimuth angle. The angle measured from the sub-satellite point (point on the ground below the platform) between the scene center and true north. Measured clockwise from north in degrees (0-360).](model-defs-properties-properties-viewing-azimuth-angle-the-angle-measured-from-the-sub-satellite-point-point-on-the-ground-below-the-platform-between-the-scene-center-and-true-north-measured-clockwise-from-north-in-degrees-0-360.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-viewing-azimuth-angle-the-angle-measured-from-the-sub-satellite-point-point-on-the-ground-below-the-platform-between-the-scene-center-and-true-north-measured-clockwise-from-north-in-degrees-0-360.md "airs_model#/$defs/Properties/properties/view__azimuth")



  merged type ([Viewing azimuth angle. The angle measured from the sub-satellite point (point on the ground below the platform) between the scene center and true north. Measured clockwise from north in degrees (0-360).](model-defs-properties-properties-viewing-azimuth-angle-the-angle-measured-from-the-sub-satellite-point-point-on-the-ground-below-the-platform-between-the-scene-center-and-true-north-measured-clockwise-from-north-in-degrees-0-360.md))

  any of

  *   [Untitled number in Item](model-defs-properties-properties-viewing-azimuth-angle-the-angle-measured-from-the-sub-satellite-point-point-on-the-ground-below-the-platform-between-the-scene-center-and-true-north-measured-clockwise-from-north-in-degrees-0-360-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-viewing-azimuth-angle-the-angle-measured-from-the-sub-satellite-point-point-on-the-ground-below-the-platform-between-the-scene-center-and-true-north-measured-clockwise-from-north-in-degrees-0-360-anyof-1.md "check type definition")





  `view__sun_azimuth`

  *   is optional

  *   Type: merged type ([Sun azimuth angle. From the scene center point on the ground, this is the angle between truth north and the sun. Measured clockwise in degrees (0-360).](model-defs-properties-properties-sun-azimuth-angle-from-the-scene-center-point-on-the-ground-this-is-the-angle-between-truth-north-and-the-sun-measured-clockwise-in-degrees-0-360.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-sun-azimuth-angle-from-the-scene-center-point-on-the-ground-this-is-the-angle-between-truth-north-and-the-sun-measured-clockwise-in-degrees-0-360.md "airs_model#/$defs/Properties/properties/view__sun_azimuth")



  merged type ([Sun azimuth angle. From the scene center point on the ground, this is the angle between truth north and the sun. Measured clockwise in degrees (0-360).](model-defs-properties-properties-sun-azimuth-angle-from-the-scene-center-point-on-the-ground-this-is-the-angle-between-truth-north-and-the-sun-measured-clockwise-in-degrees-0-360.md))

  any of

  *   [Untitled number in Item](model-defs-properties-properties-sun-azimuth-angle-from-the-scene-center-point-on-the-ground-this-is-the-angle-between-truth-north-and-the-sun-measured-clockwise-in-degrees-0-360-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-sun-azimuth-angle-from-the-scene-center-point-on-the-ground-this-is-the-angle-between-truth-north-and-the-sun-measured-clockwise-in-degrees-0-360-anyof-1.md "check type definition")





  `view__sun_elevation`

  *   is optional

  *   Type: merged type ([Sun elevation angle. The angle from the tangent of the scene center point to the sun. Measured from the horizon in degrees (-90-90). Negative values indicate the sun is below the horizon, e.g. sun elevation of -10° \[...\]](model-defs-properties-properties-sun-elevation-angle-the-angle-from-the-tangent-of-the-scene-center-point-to-the-sun-measured-from-the-horizon-in-degrees--90-90-negative-values-indicate-the-sun-is-below-the-horizon-eg-sun-elevation-of--10-.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-sun-elevation-angle-the-angle-from-the-tangent-of-the-scene-center-point-to-the-sun-measured-from-the-horizon-in-degrees--90-90-negative-values-indicate-the-sun-is-below-the-horizon-eg-sun-elevation-of--10-.md "airs_model#/$defs/Properties/properties/view__sun_elevation")



  merged type ([Sun elevation angle. The angle from the tangent of the scene center point to the sun. Measured from the horizon in degrees (-90-90). Negative values indicate the sun is below the horizon, e.g. sun elevation of -10° \[...\]](model-defs-properties-properties-sun-elevation-angle-the-angle-from-the-tangent-of-the-scene-center-point-to-the-sun-measured-from-the-horizon-in-degrees--90-90-negative-values-indicate-the-sun-is-below-the-horizon-eg-sun-elevation-of--10-.md))

  any of

  *   [Untitled number in Item](model-defs-properties-properties-sun-elevation-angle-the-angle-from-the-tangent-of-the-scene-center-point-to-the-sun-measured-from-the-horizon-in-degrees--90-90-negative-values-indicate-the-sun-is-below-the-horizon-eg-sun-elevation-of--10--anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-sun-elevation-angle-the-angle-from-the-tangent-of-the-scene-center-point-to-the-sun-measured-from-the-horizon-in-degrees--90-90-negative-values-indicate-the-sun-is-below-the-horizon-eg-sun-elevation-of--10--anyof-1.md "check type definition")





  `storage__requester_pays`

  *   is optional

  *   Type: merged type ([Is the data requester pays or is it data manager/cloud provider pays. Defaults to false. Whether the requester pays for accessing assets](model-defs-properties-properties-is-the-data-requester-pays-or-is-it-data-managercloud-provider-pays-defaults-to-false-whether-the-requester-pays-for-accessing-assets.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-is-the-data-requester-pays-or-is-it-data-managercloud-provider-pays-defaults-to-false-whether-the-requester-pays-for-accessing-assets.md "airs_model#/$defs/Properties/properties/storage__requester_pays")



  merged type ([Is the data requester pays or is it data manager/cloud provider pays. Defaults to false. Whether the requester pays for accessing assets](model-defs-properties-properties-is-the-data-requester-pays-or-is-it-data-managercloud-provider-pays-defaults-to-false-whether-the-requester-pays-for-accessing-assets.md))

  any of

  *   [Untitled boolean in Item](model-defs-properties-properties-is-the-data-requester-pays-or-is-it-data-managercloud-provider-pays-defaults-to-false-whether-the-requester-pays-for-accessing-assets-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-is-the-data-requester-pays-or-is-it-data-managercloud-provider-pays-defaults-to-false-whether-the-requester-pays-for-accessing-assets-anyof-1.md "check type definition")





  `storage__tier`

  *   is optional

  *   Type: merged type ([Cloud Provider Storage Tiers (Standard, Glacier, etc.)](model-defs-properties-properties-cloud-provider-storage-tiers-standard-glacier-etc.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-cloud-provider-storage-tiers-standard-glacier-etc.md "airs_model#/$defs/Properties/properties/storage__tier")



  merged type ([Cloud Provider Storage Tiers (Standard, Glacier, etc.)](model-defs-properties-properties-cloud-provider-storage-tiers-standard-glacier-etc.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-cloud-provider-storage-tiers-standard-glacier-etc-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-cloud-provider-storage-tiers-standard-glacier-etc-anyof-1.md "check type definition")





  `storage__platform`

  *   is optional

  *   Type: merged type ([PaaS solutions (ALIBABA, AWS, AZURE, GCP, IBM, ORACLE, OTHER)](model-defs-properties-properties-paas-solutions-alibaba-aws-azure-gcp-ibm-oracle-other.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-paas-solutions-alibaba-aws-azure-gcp-ibm-oracle-other.md "airs_model#/$defs/Properties/properties/storage__platform")



  merged type ([PaaS solutions (ALIBABA, AWS, AZURE, GCP, IBM, ORACLE, OTHER)](model-defs-properties-properties-paas-solutions-alibaba-aws-azure-gcp-ibm-oracle-other.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-paas-solutions-alibaba-aws-azure-gcp-ibm-oracle-other-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-paas-solutions-alibaba-aws-azure-gcp-ibm-oracle-other-anyof-1.md "check type definition")





  `storage__region`

  *   is optional

  *   Type: merged type ([The region where the data is stored. Relevant to speed of access and inter region egress costs (as defined by PaaS provider)](model-defs-properties-properties-the-region-where-the-data-is-stored-relevant-to-speed-of-access-and-inter-region-egress-costs-as-defined-by-paas-provider.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-the-region-where-the-data-is-stored-relevant-to-speed-of-access-and-inter-region-egress-costs-as-defined-by-paas-provider.md "airs_model#/$defs/Properties/properties/storage__region")



  merged type ([The region where the data is stored. Relevant to speed of access and inter region egress costs (as defined by PaaS provider)](model-defs-properties-properties-the-region-where-the-data-is-stored-relevant-to-speed-of-access-and-inter-region-egress-costs-as-defined-by-paas-provider.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-the-region-where-the-data-is-stored-relevant-to-speed-of-access-and-inter-region-egress-costs-as-defined-by-paas-provider-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-the-region-where-the-data-is-stored-relevant-to-speed-of-access-and-inter-region-egress-costs-as-defined-by-paas-provider-anyof-1.md "check type definition")





  `eo__cloud_cover`

  *   is optional

  *   Type: merged type ([Estimate of cloud cover.](model-defs-properties-properties-estimate-of-cloud-cover.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-estimate-of-cloud-cover.md "airs_model#/$defs/Properties/properties/eo__cloud_cover")



  merged type ([Estimate of cloud cover.](model-defs-properties-properties-estimate-of-cloud-cover.md))

  any of

  *   [Untitled number in Item](model-defs-properties-properties-estimate-of-cloud-cover-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-estimate-of-cloud-cover-anyof-1.md "check type definition")





  `eo__snow_cover`

  *   is optional

  *   Type: merged type ([Estimate of snow and ice cover.](model-defs-properties-properties-estimate-of-snow-and-ice-cover.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-estimate-of-snow-and-ice-cover.md "airs_model#/$defs/Properties/properties/eo__snow_cover")



  merged type ([Estimate of snow and ice cover.](model-defs-properties-properties-estimate-of-snow-and-ice-cover.md))

  any of

  *   [Untitled number in Item](model-defs-properties-properties-estimate-of-snow-and-ice-cover-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-estimate-of-snow-and-ice-cover-anyof-1.md "check type definition")





  `eo__bands`

  *   is optional

  *   Type: merged type ([An array of available bands where each object is a Band Object. If given, requires at least one band.](model-defs-properties-properties-an-array-of-available-bands-where-each-object-is-a-band-object-if-given-requires-at-least-one-band.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-an-array-of-available-bands-where-each-object-is-a-band-object-if-given-requires-at-least-one-band.md "airs_model#/$defs/Properties/properties/eo__bands")



  merged type ([An array of available bands where each object is a Band Object. If given, requires at least one band.](model-defs-properties-properties-an-array-of-available-bands-where-each-object-is-a-band-object-if-given-requires-at-least-one-band.md))

  any of

  *   [Untitled array in Item](model-defs-properties-properties-an-array-of-available-bands-where-each-object-is-a-band-object-if-given-requires-at-least-one-band-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-an-array-of-available-bands-where-each-object-is-a-band-object-if-given-requires-at-least-one-band-anyof-1.md "check type definition")





  `processing__expression`

  *   is optional

  *   Type: merged type ([An expression or processing chain that describes how the data has been processed. Alternatively, you can also link to a processing chain with the relation type processing-expression (see below).](model-defs-properties-properties-an-expression-or-processing-chain-that-describes-how-the-data-has-been-processed-alternatively-you-can-also-link-to-a-processing-chain-with-the-relation-type-processing-expression-see-below.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-an-expression-or-processing-chain-that-describes-how-the-data-has-been-processed-alternatively-you-can-also-link-to-a-processing-chain-with-the-relation-type-processing-expression-see-below.md "airs_model#/$defs/Properties/properties/processing__expression")



  merged type ([An expression or processing chain that describes how the data has been processed. Alternatively, you can also link to a processing chain with the relation type processing-expression (see below).](model-defs-properties-properties-an-expression-or-processing-chain-that-describes-how-the-data-has-been-processed-alternatively-you-can-also-link-to-a-processing-chain-with-the-relation-type-processing-expression-see-below.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-an-expression-or-processing-chain-that-describes-how-the-data-has-been-processed-alternatively-you-can-also-link-to-a-processing-chain-with-the-relation-type-processing-expression-see-below-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-an-expression-or-processing-chain-that-describes-how-the-data-has-been-processed-alternatively-you-can-also-link-to-a-processing-chain-with-the-relation-type-processing-expression-see-below-anyof-1.md "check type definition")





  `processing__lineage`

  *   is optional

  *   Type: merged type ([Lineage Information provided as free text information about the how observations were processed or models that were used to create the resource being described NASA ISO.](model-defs-properties-properties-lineage-information-provided-as-free-text-information-about-the-how-observations-were-processed-or-models-that-were-used-to-create-the-resource-being-described-nasa-iso.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-lineage-information-provided-as-free-text-information-about-the-how-observations-were-processed-or-models-that-were-used-to-create-the-resource-being-described-nasa-iso.md "airs_model#/$defs/Properties/properties/processing__lineage")



  merged type ([Lineage Information provided as free text information about the how observations were processed or models that were used to create the resource being described NASA ISO.](model-defs-properties-properties-lineage-information-provided-as-free-text-information-about-the-how-observations-were-processed-or-models-that-were-used-to-create-the-resource-being-described-nasa-iso.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-lineage-information-provided-as-free-text-information-about-the-how-observations-were-processed-or-models-that-were-used-to-create-the-resource-being-described-nasa-iso-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-lineage-information-provided-as-free-text-information-about-the-how-observations-were-processed-or-models-that-were-used-to-create-the-resource-being-described-nasa-iso-anyof-1.md "check type definition")





  `processing__level`

  *   is optional

  *   Type: merged type ([The name commonly used to refer to the processing level to make it easier to search for product level across collections or items. The short name must be used (only L, not Level).](model-defs-properties-properties-the-name-commonly-used-to-refer-to-the-processing-level-to-make-it-easier-to-search-for-product-level-across-collections-or-items-the-short-name-must-be-used-only-l-not-level.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-the-name-commonly-used-to-refer-to-the-processing-level-to-make-it-easier-to-search-for-product-level-across-collections-or-items-the-short-name-must-be-used-only-l-not-level.md "airs_model#/$defs/Properties/properties/processing__level")



  merged type ([The name commonly used to refer to the processing level to make it easier to search for product level across collections or items. The short name must be used (only L, not Level).](model-defs-properties-properties-the-name-commonly-used-to-refer-to-the-processing-level-to-make-it-easier-to-search-for-product-level-across-collections-or-items-the-short-name-must-be-used-only-l-not-level.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-the-name-commonly-used-to-refer-to-the-processing-level-to-make-it-easier-to-search-for-product-level-across-collections-or-items-the-short-name-must-be-used-only-l-not-level-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-the-name-commonly-used-to-refer-to-the-processing-level-to-make-it-easier-to-search-for-product-level-across-collections-or-items-the-short-name-must-be-used-only-l-not-level-anyof-1.md "check type definition")





  `processing__facility`

  *   is optional

  *   Type: merged type ([The name of the facility that produced the data. For example, Copernicus S1 Core Ground Segment - DPA for product of Sentinel-1 satellites.](model-defs-properties-properties-the-name-of-the-facility-that-produced-the-data-for-example-copernicus-s1-core-ground-segment---dpa-for-product-of-sentinel-1-satellites.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-the-name-of-the-facility-that-produced-the-data-for-example-copernicus-s1-core-ground-segment---dpa-for-product-of-sentinel-1-satellites.md "airs_model#/$defs/Properties/properties/processing__facility")



  merged type ([The name of the facility that produced the data. For example, Copernicus S1 Core Ground Segment - DPA for product of Sentinel-1 satellites.](model-defs-properties-properties-the-name-of-the-facility-that-produced-the-data-for-example-copernicus-s1-core-ground-segment---dpa-for-product-of-sentinel-1-satellites.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-the-name-of-the-facility-that-produced-the-data-for-example-copernicus-s1-core-ground-segment---dpa-for-product-of-sentinel-1-satellites-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-the-name-of-the-facility-that-produced-the-data-for-example-copernicus-s1-core-ground-segment---dpa-for-product-of-sentinel-1-satellites-anyof-1.md "check type definition")





  `processing__software`

  *   is optional

  *   Type: merged type ([A dictionary with name/version for key/value describing one or more softwares that produced the data.](model-defs-properties-properties-a-dictionary-with-nameversion-for-keyvalue-describing-one-or-more-softwares-that-produced-the-data.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-a-dictionary-with-nameversion-for-keyvalue-describing-one-or-more-softwares-that-produced-the-data.md "airs_model#/$defs/Properties/properties/processing__software")



  merged type ([A dictionary with name/version for key/value describing one or more softwares that produced the data.](model-defs-properties-properties-a-dictionary-with-nameversion-for-keyvalue-describing-one-or-more-softwares-that-produced-the-data.md))

  any of

  *   [Untitled object in Item](model-defs-properties-properties-a-dictionary-with-nameversion-for-keyvalue-describing-one-or-more-softwares-that-produced-the-data-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-a-dictionary-with-nameversion-for-keyvalue-describing-one-or-more-softwares-that-produced-the-data-anyof-1.md "check type definition")





  `dc3__quality_indicators`

  *   is optional

  *   Type: merged type ([Set of indicators for estimating the quality of the datacube based on the composition. The indicators are group based. A cube indicator is the product of its corresponding group indicator.](model-defs-properties-properties-set-of-indicators-for-estimating-the-quality-of-the-datacube-based-on-the-composition-the-indicators-are-group-based-a-cube-indicator-is-the-product-of-its-corresponding-group-indicator.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-set-of-indicators-for-estimating-the-quality-of-the-datacube-based-on-the-composition-the-indicators-are-group-based-a-cube-indicator-is-the-product-of-its-corresponding-group-indicator.md "airs_model#/$defs/Properties/properties/dc3__quality_indicators")



  merged type ([Set of indicators for estimating the quality of the datacube based on the composition. The indicators are group based. A cube indicator is the product of its corresponding group indicator.](model-defs-properties-properties-set-of-indicators-for-estimating-the-quality-of-the-datacube-based-on-the-composition-the-indicators-are-group-based-a-cube-indicator-is-the-product-of-its-corresponding-group-indicator.md))

  any of

  *   [Indicators](model-defs-indicators.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-set-of-indicators-for-estimating-the-quality-of-the-datacube-based-on-the-composition-the-indicators-are-group-based-a-cube-indicator-is-the-product-of-its-corresponding-group-indicator-anyof-1.md "check type definition")





  `dc3__composition`

  *   is optional

  *   Type: merged type ([List of raster groups used for elaborating the cube temporal slices.](model-defs-properties-properties-list-of-raster-groups-used-for-elaborating-the-cube-temporal-slices.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-list-of-raster-groups-used-for-elaborating-the-cube-temporal-slices.md "airs_model#/$defs/Properties/properties/dc3__composition")



  merged type ([List of raster groups used for elaborating the cube temporal slices.](model-defs-properties-properties-list-of-raster-groups-used-for-elaborating-the-cube-temporal-slices.md))

  any of

  *   [Untitled array in Item](model-defs-properties-properties-list-of-raster-groups-used-for-elaborating-the-cube-temporal-slices-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-list-of-raster-groups-used-for-elaborating-the-cube-temporal-slices-anyof-1.md "check type definition")





  `dc3__number_of_chunks`

  *   is optional

  *   Type: merged type ([Number of chunks (if zarr or similar partitioned format) within the cube.](model-defs-properties-properties-number-of-chunks-if-zarr-or-similar-partitioned-format-within-the-cube.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-number-of-chunks-if-zarr-or-similar-partitioned-format-within-the-cube.md "airs_model#/$defs/Properties/properties/dc3__number_of_chunks")



  merged type ([Number of chunks (if zarr or similar partitioned format) within the cube.](model-defs-properties-properties-number-of-chunks-if-zarr-or-similar-partitioned-format-within-the-cube.md))

  any of

  *   [Untitled integer in Item](model-defs-properties-properties-number-of-chunks-if-zarr-or-similar-partitioned-format-within-the-cube-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-number-of-chunks-if-zarr-or-similar-partitioned-format-within-the-cube-anyof-1.md "check type definition")





  `dc3__chunk_weight`

  *   is optional

  *   Type: merged type ([Weight of a chunk (number of bytes).](model-defs-properties-properties-weight-of-a-chunk-number-of-bytes.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-weight-of-a-chunk-number-of-bytes.md "airs_model#/$defs/Properties/properties/dc3__chunk_weight")



  merged type ([Weight of a chunk (number of bytes).](model-defs-properties-properties-weight-of-a-chunk-number-of-bytes.md))

  any of

  *   [Untitled integer in Item](model-defs-properties-properties-weight-of-a-chunk-number-of-bytes-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-weight-of-a-chunk-number-of-bytes-anyof-1.md "check type definition")





  `dc3__fill_ratio`

  *   is optional

  *   Type: merged type ([1: the cube is full, 0 the cube is empty, in between the cube is partially filled.](model-defs-properties-properties-1-the-cube-is-full-0-the-cube-is-empty-in-between-the-cube-is-partially-filled.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-1-the-cube-is-full-0-the-cube-is-empty-in-between-the-cube-is-partially-filled.md "airs_model#/$defs/Properties/properties/dc3__fill_ratio")



  merged type ([1: the cube is full, 0 the cube is empty, in between the cube is partially filled.](model-defs-properties-properties-1-the-cube-is-full-0-the-cube-is-empty-in-between-the-cube-is-partially-filled.md))

  any of

  *   [Untitled number in Item](model-defs-properties-properties-1-the-cube-is-full-0-the-cube-is-empty-in-between-the-cube-is-partially-filled-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-1-the-cube-is-full-0-the-cube-is-empty-in-between-the-cube-is-partially-filled-anyof-1.md "check type definition")





  `cube__dimensions`

  *   is optional

  *   Type: merged type ([Uniquely named dimensions of the datacube.](model-defs-properties-properties-uniquely-named-dimensions-of-the-datacube.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-uniquely-named-dimensions-of-the-datacube.md "airs_model#/$defs/Properties/properties/cube__dimensions")



  merged type ([Uniquely named dimensions of the datacube.](model-defs-properties-properties-uniquely-named-dimensions-of-the-datacube.md))

  any of

  *   [Untitled object in Item](model-defs-properties-properties-uniquely-named-dimensions-of-the-datacube-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-uniquely-named-dimensions-of-the-datacube-anyof-1.md "check type definition")





  `cube__variables`

  *   is optional

  *   Type: merged type ([Uniquely named variables of the datacube.](model-defs-properties-properties-uniquely-named-variables-of-the-datacube.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-uniquely-named-variables-of-the-datacube.md "airs_model#/$defs/Properties/properties/cube__variables")



  merged type ([Uniquely named variables of the datacube.](model-defs-properties-properties-uniquely-named-variables-of-the-datacube.md))

  any of

  *   [Untitled object in Item](model-defs-properties-properties-uniquely-named-variables-of-the-datacube-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-uniquely-named-variables-of-the-datacube-anyof-1.md "check type definition")





  `acq__acquisition_mode`

  *   is optional

  *   Type: merged type ([The name of the acquisition mode.](model-defs-properties-properties-the-name-of-the-acquisition-mode.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-the-name-of-the-acquisition-mode.md "airs_model#/$defs/Properties/properties/acq__acquisition_mode")



  merged type ([The name of the acquisition mode.](model-defs-properties-properties-the-name-of-the-acquisition-mode.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-the-name-of-the-acquisition-mode-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-the-name-of-the-acquisition-mode-anyof-1.md "check type definition")





  `acq__acquisition_orbit_direction`

  *   is optional

  *   Type: merged type ([Acquisition orbit direction (ASCENDING or DESCENDING).](model-defs-properties-properties-acquisition-orbit-direction-ascending-or-descending.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-acquisition-orbit-direction-ascending-or-descending.md "airs_model#/$defs/Properties/properties/acq__acquisition_orbit_direction")



  merged type ([Acquisition orbit direction (ASCENDING or DESCENDING).](model-defs-properties-properties-acquisition-orbit-direction-ascending-or-descending.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-acquisition-orbit-direction-ascending-or-descending-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-acquisition-orbit-direction-ascending-or-descending-anyof-1.md "check type definition")





  `acq__acquisition_type`

  *   is optional

  *   Type: merged type ([Acquisition type (STRIP)](model-defs-properties-properties-acquisition-type-strip.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-acquisition-type-strip.md "airs_model#/$defs/Properties/properties/acq__acquisition_type")



  merged type ([Acquisition type (STRIP)](model-defs-properties-properties-acquisition-type-strip.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-acquisition-type-strip-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-acquisition-type-strip-anyof-1.md "check type definition")





  `acq__acquisition_orbit`

  *   is optional

  *   Type: merged type ([Acquisition orbit](model-defs-properties-properties-acquisition-orbit.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-acquisition-orbit.md "airs_model#/$defs/Properties/properties/acq__acquisition_orbit")



  merged type ([Acquisition orbit](model-defs-properties-properties-acquisition-orbit.md))

  any of

  *   [Untitled number in Item](model-defs-properties-properties-acquisition-orbit-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-acquisition-orbit-anyof-1.md "check type definition")





  `acq__across_track`

  *   is optional

  *   Type: merged type ([Across track angle](model-defs-properties-properties-across-track-angle.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-across-track-angle.md "airs_model#/$defs/Properties/properties/acq__across_track")



  merged type ([Across track angle](model-defs-properties-properties-across-track-angle.md))

  any of

  *   [Untitled number in Item](model-defs-properties-properties-across-track-angle-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-across-track-angle-anyof-1.md "check type definition")





  `acq__along_track`

  *   is optional

  *   Type: merged type ([Along track angle](model-defs-properties-properties-along-track-angle.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-along-track-angle.md "airs_model#/$defs/Properties/properties/acq__along_track")



  merged type ([Along track angle](model-defs-properties-properties-along-track-angle.md))

  any of

  *   [Untitled number in Item](model-defs-properties-properties-along-track-angle-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-along-track-angle-anyof-1.md "check type definition")





  `acq__archiving_date`

  *   is optional

  *   Type: merged type ([Archiving date](model-defs-properties-properties-archiving-date.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-archiving-date.md "airs_model#/$defs/Properties/properties/acq__archiving_date")



  merged type ([Archiving date](model-defs-properties-properties-archiving-date.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-archiving-date-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-archiving-date-anyof-1.md "check type definition")





  `acq__download_orbit`

  *   is optional

  *   Type: merged type ([Download orbit](model-defs-properties-properties-download-orbit.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-download-orbit.md "airs_model#/$defs/Properties/properties/acq__download_orbit")



  merged type ([Download orbit](model-defs-properties-properties-download-orbit.md))

  any of

  *   [Untitled number in Item](model-defs-properties-properties-download-orbit-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-download-orbit-anyof-1.md "check type definition")





  `acq__request_id`

  *   is optional

  *   Type: merged type ([Original request identifier](model-defs-properties-properties-original-request-identifier.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-original-request-identifier.md "airs_model#/$defs/Properties/properties/acq__request_id")



  merged type ([Original request identifier](model-defs-properties-properties-original-request-identifier.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-original-request-identifier-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-original-request-identifier-anyof-1.md "check type definition")





  `acq__quality_average`

  *   is optional

  *   Type: merged type ([Quality average](model-defs-properties-properties-quality-average.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-quality-average.md "airs_model#/$defs/Properties/properties/acq__quality_average")



  merged type ([Quality average](model-defs-properties-properties-quality-average.md))

  any of

  *   [Untitled number in Item](model-defs-properties-properties-quality-average-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-quality-average-anyof-1.md "check type definition")





  `acq__quality_computation`

  *   is optional

  *   Type: merged type ([Quality computation](model-defs-properties-properties-quality-computation.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-quality-computation.md "airs_model#/$defs/Properties/properties/acq__quality_computation")



  merged type ([Quality computation](model-defs-properties-properties-quality-computation.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-quality-computation-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-quality-computation-anyof-1.md "check type definition")





  `acq__receiving_station`

  *   is optional

  *   Type: merged type ([Receiving station](model-defs-properties-properties-receiving-station.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-receiving-station.md "airs_model#/$defs/Properties/properties/acq__receiving_station")



  merged type ([Receiving station](model-defs-properties-properties-receiving-station.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-receiving-station-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-receiving-station-anyof-1.md "check type definition")





  `acq__reception_date`

  *   is optional

  *   Type: merged type ([Reception date](model-defs-properties-properties-reception-date.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-reception-date.md "airs_model#/$defs/Properties/properties/acq__reception_date")



  merged type ([Reception date](model-defs-properties-properties-reception-date.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-reception-date-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-reception-date-anyof-1.md "check type definition")





  `acq__spectral_mode`

  *   is optional

  *   Type: merged type ([Spectral mode](model-defs-properties-properties-spectral-mode.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-spectral-mode.md "airs_model#/$defs/Properties/properties/acq__spectral_mode")



  merged type ([Spectral mode](model-defs-properties-properties-spectral-mode.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-spectral-mode-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-spectral-mode-anyof-1.md "check type definition")





  `sar__instrument_mode`

  *   is optional

  *   Type: merged type ([The name of the sensor acquisition mode that is commonly used. This should be the short name, if available. For example, WV for "Wave mode" of Sentinel-1 and Envisat ASAR satellites.](model-defs-properties-properties-the-name-of-the-sensor-acquisition-mode-that-is-commonly-used-this-should-be-the-short-name-if-available-for-example-wv-for-wave-mode-of-sentinel-1-and-envisat-asar-satellites.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-the-name-of-the-sensor-acquisition-mode-that-is-commonly-used-this-should-be-the-short-name-if-available-for-example-wv-for-wave-mode-of-sentinel-1-and-envisat-asar-satellites.md "airs_model#/$defs/Properties/properties/sar__instrument_mode")



  merged type ([The name of the sensor acquisition mode that is commonly used. This should be the short name, if available. For example, WV for "Wave mode" of Sentinel-1 and Envisat ASAR satellites.](model-defs-properties-properties-the-name-of-the-sensor-acquisition-mode-that-is-commonly-used-this-should-be-the-short-name-if-available-for-example-wv-for-wave-mode-of-sentinel-1-and-envisat-asar-satellites.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-the-name-of-the-sensor-acquisition-mode-that-is-commonly-used-this-should-be-the-short-name-if-available-for-example-wv-for-wave-mode-of-sentinel-1-and-envisat-asar-satellites-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-the-name-of-the-sensor-acquisition-mode-that-is-commonly-used-this-should-be-the-short-name-if-available-for-example-wv-for-wave-mode-of-sentinel-1-and-envisat-asar-satellites-anyof-1.md "check type definition")





  `sar__frequency_band`

  *   is optional

  *   Type: merged type ([The common name for the frequency band to make it easier to search for bands across instruments. See section "Common Frequency Band Names" for a list of accepted names.](model-defs-properties-properties-the-common-name-for-the-frequency-band-to-make-it-easier-to-search-for-bands-across-instruments-see-section-common-frequency-band-names-for-a-list-of-accepted-names.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-the-common-name-for-the-frequency-band-to-make-it-easier-to-search-for-bands-across-instruments-see-section-common-frequency-band-names-for-a-list-of-accepted-names.md "airs_model#/$defs/Properties/properties/sar__frequency_band")



  merged type ([The common name for the frequency band to make it easier to search for bands across instruments. See section "Common Frequency Band Names" for a list of accepted names.](model-defs-properties-properties-the-common-name-for-the-frequency-band-to-make-it-easier-to-search-for-bands-across-instruments-see-section-common-frequency-band-names-for-a-list-of-accepted-names.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-the-common-name-for-the-frequency-band-to-make-it-easier-to-search-for-bands-across-instruments-see-section-common-frequency-band-names-for-a-list-of-accepted-names-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-the-common-name-for-the-frequency-band-to-make-it-easier-to-search-for-bands-across-instruments-see-section-common-frequency-band-names-for-a-list-of-accepted-names-anyof-1.md "check type definition")





  `sar__center_frequency`

  *   is optional

  *   Type: merged type ([The center frequency of the instrument, in gigahertz (GHz).](model-defs-properties-properties-the-center-frequency-of-the-instrument-in-gigahertz-ghz.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-the-center-frequency-of-the-instrument-in-gigahertz-ghz.md "airs_model#/$defs/Properties/properties/sar__center_frequency")



  merged type ([The center frequency of the instrument, in gigahertz (GHz).](model-defs-properties-properties-the-center-frequency-of-the-instrument-in-gigahertz-ghz.md))

  any of

  *   [Untitled number in Item](model-defs-properties-properties-the-center-frequency-of-the-instrument-in-gigahertz-ghz-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-the-center-frequency-of-the-instrument-in-gigahertz-ghz-anyof-1.md "check type definition")





  `sar__polarizations`

  *   is optional

  *   Type: merged type ([Any combination of polarizations.](model-defs-properties-properties-any-combination-of-polarizations.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-any-combination-of-polarizations.md "airs_model#/$defs/Properties/properties/sar__polarizations")



  merged type ([Any combination of polarizations.](model-defs-properties-properties-any-combination-of-polarizations.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-any-combination-of-polarizations-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-any-combination-of-polarizations-anyof-1.md "check type definition")





  `sar__product_type`

  *   is optional

  *   Type: merged type ([The product type, for example SSC, MGD, or SGC](model-defs-properties-properties-the-product-type-for-example-ssc-mgd-or-sgc.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-the-product-type-for-example-ssc-mgd-or-sgc.md "airs_model#/$defs/Properties/properties/sar__product_type")



  merged type ([The product type, for example SSC, MGD, or SGC](model-defs-properties-properties-the-product-type-for-example-ssc-mgd-or-sgc.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-the-product-type-for-example-ssc-mgd-or-sgc-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-the-product-type-for-example-ssc-mgd-or-sgc-anyof-1.md "check type definition")





  `sar__resolution_range`

  *   is optional

  *   Type: merged type ([The range resolution, which is the maximum ability to distinguish two adjacent targets perpendicular to the flight path, in meters (m).](model-defs-properties-properties-the-range-resolution-which-is-the-maximum-ability-to-distinguish-two-adjacent-targets-perpendicular-to-the-flight-path-in-meters-m.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-the-range-resolution-which-is-the-maximum-ability-to-distinguish-two-adjacent-targets-perpendicular-to-the-flight-path-in-meters-m.md "airs_model#/$defs/Properties/properties/sar__resolution_range")



  merged type ([The range resolution, which is the maximum ability to distinguish two adjacent targets perpendicular to the flight path, in meters (m).](model-defs-properties-properties-the-range-resolution-which-is-the-maximum-ability-to-distinguish-two-adjacent-targets-perpendicular-to-the-flight-path-in-meters-m.md))

  any of

  *   [Untitled number in Item](model-defs-properties-properties-the-range-resolution-which-is-the-maximum-ability-to-distinguish-two-adjacent-targets-perpendicular-to-the-flight-path-in-meters-m-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-the-range-resolution-which-is-the-maximum-ability-to-distinguish-two-adjacent-targets-perpendicular-to-the-flight-path-in-meters-m-anyof-1.md "check type definition")





  `sar__resolution_azimuth`

  *   is optional

  *   Type: merged type ([The azimuth resolution, which is the maximum ability to distinguish two adjacent targets parallel to the flight path, in meters (m).](model-defs-properties-properties-the-azimuth-resolution-which-is-the-maximum-ability-to-distinguish-two-adjacent-targets-parallel-to-the-flight-path-in-meters-m.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-the-azimuth-resolution-which-is-the-maximum-ability-to-distinguish-two-adjacent-targets-parallel-to-the-flight-path-in-meters-m.md "airs_model#/$defs/Properties/properties/sar__resolution_azimuth")



  merged type ([The azimuth resolution, which is the maximum ability to distinguish two adjacent targets parallel to the flight path, in meters (m).](model-defs-properties-properties-the-azimuth-resolution-which-is-the-maximum-ability-to-distinguish-two-adjacent-targets-parallel-to-the-flight-path-in-meters-m.md))

  any of

  *   [Untitled number in Item](model-defs-properties-properties-the-azimuth-resolution-which-is-the-maximum-ability-to-distinguish-two-adjacent-targets-parallel-to-the-flight-path-in-meters-m-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-the-azimuth-resolution-which-is-the-maximum-ability-to-distinguish-two-adjacent-targets-parallel-to-the-flight-path-in-meters-m-anyof-1.md "check type definition")





  `sar__pixel_spacing_range`

  *   is optional

  *   Type: merged type ([The range pixel spacing, which is the distance between adjacent pixels perpendicular to the flight path, in meters (m). Strongly RECOMMENDED to be specified for products of type GRD.](model-defs-properties-properties-the-range-pixel-spacing-which-is-the-distance-between-adjacent-pixels-perpendicular-to-the-flight-path-in-meters-m-strongly-recommended-to-be-specified-for-products-of-type-grd.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-the-range-pixel-spacing-which-is-the-distance-between-adjacent-pixels-perpendicular-to-the-flight-path-in-meters-m-strongly-recommended-to-be-specified-for-products-of-type-grd.md "airs_model#/$defs/Properties/properties/sar__pixel_spacing_range")



  merged type ([The range pixel spacing, which is the distance between adjacent pixels perpendicular to the flight path, in meters (m). Strongly RECOMMENDED to be specified for products of type GRD.](model-defs-properties-properties-the-range-pixel-spacing-which-is-the-distance-between-adjacent-pixels-perpendicular-to-the-flight-path-in-meters-m-strongly-recommended-to-be-specified-for-products-of-type-grd.md))

  any of

  *   [Untitled number in Item](model-defs-properties-properties-the-range-pixel-spacing-which-is-the-distance-between-adjacent-pixels-perpendicular-to-the-flight-path-in-meters-m-strongly-recommended-to-be-specified-for-products-of-type-grd-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-the-range-pixel-spacing-which-is-the-distance-between-adjacent-pixels-perpendicular-to-the-flight-path-in-meters-m-strongly-recommended-to-be-specified-for-products-of-type-grd-anyof-1.md "check type definition")





  `sar__pixel_spacing_azimuth`

  *   is optional

  *   Type: merged type ([The azimuth pixel spacing, which is the distance between adjacent pixels parallel to the flight path, in meters (m). Strongly RECOMMENDED to be specified for products of type GRD.](model-defs-properties-properties-the-azimuth-pixel-spacing-which-is-the-distance-between-adjacent-pixels-parallel-to-the-flight-path-in-meters-m-strongly-recommended-to-be-specified-for-products-of-type-grd.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-the-azimuth-pixel-spacing-which-is-the-distance-between-adjacent-pixels-parallel-to-the-flight-path-in-meters-m-strongly-recommended-to-be-specified-for-products-of-type-grd.md "airs_model#/$defs/Properties/properties/sar__pixel_spacing_azimuth")



  merged type ([The azimuth pixel spacing, which is the distance between adjacent pixels parallel to the flight path, in meters (m). Strongly RECOMMENDED to be specified for products of type GRD.](model-defs-properties-properties-the-azimuth-pixel-spacing-which-is-the-distance-between-adjacent-pixels-parallel-to-the-flight-path-in-meters-m-strongly-recommended-to-be-specified-for-products-of-type-grd.md))

  any of

  *   [Untitled number in Item](model-defs-properties-properties-the-azimuth-pixel-spacing-which-is-the-distance-between-adjacent-pixels-parallel-to-the-flight-path-in-meters-m-strongly-recommended-to-be-specified-for-products-of-type-grd-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-the-azimuth-pixel-spacing-which-is-the-distance-between-adjacent-pixels-parallel-to-the-flight-path-in-meters-m-strongly-recommended-to-be-specified-for-products-of-type-grd-anyof-1.md "check type definition")





  `sar__looks_range`

  *   is optional

  *   Type: merged type ([Number of range looks, which is the number of groups of signal samples (looks) perpendicular to the flight path.](model-defs-properties-properties-number-of-range-looks-which-is-the-number-of-groups-of-signal-samples-looks-perpendicular-to-the-flight-path.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-number-of-range-looks-which-is-the-number-of-groups-of-signal-samples-looks-perpendicular-to-the-flight-path.md "airs_model#/$defs/Properties/properties/sar__looks_range")



  merged type ([Number of range looks, which is the number of groups of signal samples (looks) perpendicular to the flight path.](model-defs-properties-properties-number-of-range-looks-which-is-the-number-of-groups-of-signal-samples-looks-perpendicular-to-the-flight-path.md))

  any of

  *   [Untitled number in Item](model-defs-properties-properties-number-of-range-looks-which-is-the-number-of-groups-of-signal-samples-looks-perpendicular-to-the-flight-path-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-number-of-range-looks-which-is-the-number-of-groups-of-signal-samples-looks-perpendicular-to-the-flight-path-anyof-1.md "check type definition")





  `sar__looks_azimuth`

  *   is optional

  *   Type: merged type ([Number of azimuth looks, which is the number of groups of signal samples (looks) parallel to the flight path.](model-defs-properties-properties-number-of-azimuth-looks-which-is-the-number-of-groups-of-signal-samples-looks-parallel-to-the-flight-path.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-number-of-azimuth-looks-which-is-the-number-of-groups-of-signal-samples-looks-parallel-to-the-flight-path.md "airs_model#/$defs/Properties/properties/sar__looks_azimuth")



  merged type ([Number of azimuth looks, which is the number of groups of signal samples (looks) parallel to the flight path.](model-defs-properties-properties-number-of-azimuth-looks-which-is-the-number-of-groups-of-signal-samples-looks-parallel-to-the-flight-path.md))

  any of

  *   [Untitled number in Item](model-defs-properties-properties-number-of-azimuth-looks-which-is-the-number-of-groups-of-signal-samples-looks-parallel-to-the-flight-path-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-number-of-azimuth-looks-which-is-the-number-of-groups-of-signal-samples-looks-parallel-to-the-flight-path-anyof-1.md "check type definition")





  `sar__looks_equivalent_number`

  *   is optional

  *   Type: merged type ([The equivalent number of looks (ENL).](model-defs-properties-properties-the-equivalent-number-of-looks-enl.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-the-equivalent-number-of-looks-enl.md "airs_model#/$defs/Properties/properties/sar__looks_equivalent_number")



  merged type ([The equivalent number of looks (ENL).](model-defs-properties-properties-the-equivalent-number-of-looks-enl.md))

  any of

  *   [Untitled number in Item](model-defs-properties-properties-the-equivalent-number-of-looks-enl-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-the-equivalent-number-of-looks-enl-anyof-1.md "check type definition")





  `sar__observation_direction`

  *   is optional

  *   Type: merged type ([Antenna pointing direction relative to the flight trajectory of the satellite, either left or right.](model-defs-properties-properties-antenna-pointing-direction-relative-to-the-flight-trajectory-of-the-satellite-either-left-or-right.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-antenna-pointing-direction-relative-to-the-flight-trajectory-of-the-satellite-either-left-or-right.md "airs_model#/$defs/Properties/properties/sar__observation_direction")



  merged type ([Antenna pointing direction relative to the flight trajectory of the satellite, either left or right.](model-defs-properties-properties-antenna-pointing-direction-relative-to-the-flight-trajectory-of-the-satellite-either-left-or-right.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-antenna-pointing-direction-relative-to-the-flight-trajectory-of-the-satellite-either-left-or-right-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-antenna-pointing-direction-relative-to-the-flight-trajectory-of-the-satellite-either-left-or-right-anyof-1.md "check type definition")





  `proj__epsg`

  *   is optional

  *   Type: merged type ([EPSG code of the datasource.](model-defs-properties-properties-epsg-code-of-the-datasource.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-epsg-code-of-the-datasource.md "airs_model#/$defs/Properties/properties/proj__epsg")



  merged type ([EPSG code of the datasource.](model-defs-properties-properties-epsg-code-of-the-datasource.md))

  any of

  *   [Untitled integer in Item](model-defs-properties-properties-epsg-code-of-the-datasource-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-epsg-code-of-the-datasource-anyof-1.md "check type definition")





  `proj__wkt2`

  *   is optional

  *   Type: merged type ([PROJJSON object representing the Coordinate Reference System (CRS) that the proj:geometry and proj:bbox fields represent.](model-defs-properties-properties-projjson-object-representing-the-coordinate-reference-system-crs-that-the-projgeometry-and-projbbox-fields-represent.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-projjson-object-representing-the-coordinate-reference-system-crs-that-the-projgeometry-and-projbbox-fields-represent.md "airs_model#/$defs/Properties/properties/proj__wkt2")



  merged type ([PROJJSON object representing the Coordinate Reference System (CRS) that the proj:geometry and proj:bbox fields represent.](model-defs-properties-properties-projjson-object-representing-the-coordinate-reference-system-crs-that-the-projgeometry-and-projbbox-fields-represent.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-projjson-object-representing-the-coordinate-reference-system-crs-that-the-projgeometry-and-projbbox-fields-represent-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-projjson-object-representing-the-coordinate-reference-system-crs-that-the-projgeometry-and-projbbox-fields-represent-anyof-1.md "check type definition")





  `proj__geometry`

  *   is optional

  *   Type: merged type ([Defines the footprint of this Item.](model-defs-properties-properties-defines-the-footprint-of-this-item.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-defines-the-footprint-of-this-item.md "airs_model#/$defs/Properties/properties/proj__geometry")



  merged type ([Defines the footprint of this Item.](model-defs-properties-properties-defines-the-footprint-of-this-item.md))

  any of

  *   [Untitled undefined type in Item](model-defs-properties-properties-defines-the-footprint-of-this-item-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-defines-the-footprint-of-this-item-anyof-1.md "check type definition")





  `proj__bbox`

  *   is optional

  *   Type: merged type ([Bounding box of the Item in the asset CRS in 2 or 3 dimensions.](model-defs-properties-properties-bounding-box-of-the-item-in-the-asset-crs-in-2-or-3-dimensions.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-bounding-box-of-the-item-in-the-asset-crs-in-2-or-3-dimensions.md "airs_model#/$defs/Properties/properties/proj__bbox")



  merged type ([Bounding box of the Item in the asset CRS in 2 or 3 dimensions.](model-defs-properties-properties-bounding-box-of-the-item-in-the-asset-crs-in-2-or-3-dimensions.md))

  any of

  *   [Untitled array in Item](model-defs-properties-properties-bounding-box-of-the-item-in-the-asset-crs-in-2-or-3-dimensions-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-bounding-box-of-the-item-in-the-asset-crs-in-2-or-3-dimensions-anyof-1.md "check type definition")





  `proj__centroid`

  *   is optional

  *   Type: merged type ([Coordinates representing the centroid of the Item (in lat/long).](model-defs-properties-properties-coordinates-representing-the-centroid-of-the-item-in-latlong.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-coordinates-representing-the-centroid-of-the-item-in-latlong.md "airs_model#/$defs/Properties/properties/proj__centroid")



  merged type ([Coordinates representing the centroid of the Item (in lat/long).](model-defs-properties-properties-coordinates-representing-the-centroid-of-the-item-in-latlong.md))

  any of

  *   [Untitled undefined type in Item](model-defs-properties-properties-coordinates-representing-the-centroid-of-the-item-in-latlong-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-coordinates-representing-the-centroid-of-the-item-in-latlong-anyof-1.md "check type definition")





  `proj__shape`

  *   is optional

  *   Type: merged type ([Number of pixels in Y and X directions for the default grid.](model-defs-properties-properties-number-of-pixels-in-y-and-x-directions-for-the-default-grid.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-number-of-pixels-in-y-and-x-directions-for-the-default-grid.md "airs_model#/$defs/Properties/properties/proj__shape")



  merged type ([Number of pixels in Y and X directions for the default grid.](model-defs-properties-properties-number-of-pixels-in-y-and-x-directions-for-the-default-grid.md))

  any of

  *   [Untitled array in Item](model-defs-properties-properties-number-of-pixels-in-y-and-x-directions-for-the-default-grid-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-number-of-pixels-in-y-and-x-directions-for-the-default-grid-anyof-1.md "check type definition")





  `proj__transform`

  *   is optional

  *   Type: merged type ([The affine transformation coefficients for the default grid.](model-defs-properties-properties-the-affine-transformation-coefficients-for-the-default-grid.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-the-affine-transformation-coefficients-for-the-default-grid.md "airs_model#/$defs/Properties/properties/proj__transform")



  merged type ([The affine transformation coefficients for the default grid.](model-defs-properties-properties-the-affine-transformation-coefficients-for-the-default-grid.md))

  any of

  *   [Untitled array in Item](model-defs-properties-properties-the-affine-transformation-coefficients-for-the-default-grid-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-the-affine-transformation-coefficients-for-the-default-grid-anyof-1.md "check type definition")





  `generated__has_overview`

  *   is optional

  *   Type: merged type ([Whether the item has an overview or not.](model-defs-properties-properties-whether-the-item-has-an-overview-or-not.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-whether-the-item-has-an-overview-or-not.md "airs_model#/$defs/Properties/properties/generated__has_overview")



  merged type ([Whether the item has an overview or not.](model-defs-properties-properties-whether-the-item-has-an-overview-or-not.md))

  any of

  *   [Untitled boolean in Item](model-defs-properties-properties-whether-the-item-has-an-overview-or-not-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-whether-the-item-has-an-overview-or-not-anyof-1.md "check type definition")





  `generated__has_thumbnail`

  *   is optional

  *   Type: merged type ([Whether the item has a thumbnail or not.](model-defs-properties-properties-whether-the-item-has-a-thumbnail-or-not.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-whether-the-item-has-a-thumbnail-or-not.md "airs_model#/$defs/Properties/properties/generated__has_thumbnail")



  merged type ([Whether the item has a thumbnail or not.](model-defs-properties-properties-whether-the-item-has-a-thumbnail-or-not.md))

  any of

  *   [Untitled boolean in Item](model-defs-properties-properties-whether-the-item-has-a-thumbnail-or-not-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-whether-the-item-has-a-thumbnail-or-not-anyof-1.md "check type definition")





  `generated__has_metadata`

  *   is optional

  *   Type: merged type ([Whether the item has a metadata file or not.](model-defs-properties-properties-whether-the-item-has-a-metadata-file-or-not.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-whether-the-item-has-a-metadata-file-or-not.md "airs_model#/$defs/Properties/properties/generated__has_metadata")



  merged type ([Whether the item has a metadata file or not.](model-defs-properties-properties-whether-the-item-has-a-metadata-file-or-not.md))

  any of

  *   [Untitled boolean in Item](model-defs-properties-properties-whether-the-item-has-a-metadata-file-or-not-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-whether-the-item-has-a-metadata-file-or-not-anyof-1.md "check type definition")





  `generated__has_data`

  *   is optional

  *   Type: merged type ([Whether the item has a data file or not.](model-defs-properties-properties-whether-the-item-has-a-data-file-or-not.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-whether-the-item-has-a-data-file-or-not.md "airs_model#/$defs/Properties/properties/generated__has_data")



  merged type ([Whether the item has a data file or not.](model-defs-properties-properties-whether-the-item-has-a-data-file-or-not.md))

  any of

  *   [Untitled boolean in Item](model-defs-properties-properties-whether-the-item-has-a-data-file-or-not-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-whether-the-item-has-a-data-file-or-not-anyof-1.md "check type definition")





  `generated__has_cog`

  *   is optional

  *   Type: merged type ([Whether the item has a cog or not.](model-defs-properties-properties-whether-the-item-has-a-cog-or-not.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-whether-the-item-has-a-cog-or-not.md "airs_model#/$defs/Properties/properties/generated__has_cog")



  merged type ([Whether the item has a cog or not.](model-defs-properties-properties-whether-the-item-has-a-cog-or-not.md))

  any of

  *   [Untitled boolean in Item](model-defs-properties-properties-whether-the-item-has-a-cog-or-not-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-whether-the-item-has-a-cog-or-not-anyof-1.md "check type definition")





  `generated__has_zarr`

  *   is optional

  *   Type: merged type ([Whether the item has a zarr or not.](model-defs-properties-properties-whether-the-item-has-a-zarr-or-not.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-whether-the-item-has-a-zarr-or-not.md "airs_model#/$defs/Properties/properties/generated__has_zarr")



  merged type ([Whether the item has a zarr or not.](model-defs-properties-properties-whether-the-item-has-a-zarr-or-not.md))

  any of

  *   [Untitled boolean in Item](model-defs-properties-properties-whether-the-item-has-a-zarr-or-not-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-whether-the-item-has-a-zarr-or-not-anyof-1.md "check type definition")





  `generated__date_keywords`

  *   is optional

  *   Type: merged type ([A list of keywords indicating clues on the date](model-defs-properties-properties-a-list-of-keywords-indicating-clues-on-the-date.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-a-list-of-keywords-indicating-clues-on-the-date.md "airs_model#/$defs/Properties/properties/generated__date_keywords")



  merged type ([A list of keywords indicating clues on the date](model-defs-properties-properties-a-list-of-keywords-indicating-clues-on-the-date.md))

  any of

  *   [Untitled array in Item](model-defs-properties-properties-a-list-of-keywords-indicating-clues-on-the-date-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-a-list-of-keywords-indicating-clues-on-the-date-anyof-1.md "check type definition")





  `generated__day_of_week`

  *   is optional

  *   Type: merged type ([Day of week.](model-defs-properties-properties-day-of-week.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-day-of-week.md "airs_model#/$defs/Properties/properties/generated__day_of_week")



  merged type ([Day of week.](model-defs-properties-properties-day-of-week.md))

  any of

  *   [Untitled integer in Item](model-defs-properties-properties-day-of-week-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-day-of-week-anyof-1.md "check type definition")





  `generated__day_of_year`

  *   is optional

  *   Type: merged type ([Day of year.](model-defs-properties-properties-day-of-year.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-day-of-year.md "airs_model#/$defs/Properties/properties/generated__day_of_year")



  merged type ([Day of year.](model-defs-properties-properties-day-of-year.md))

  any of

  *   [Untitled integer in Item](model-defs-properties-properties-day-of-year-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-day-of-year-anyof-1.md "check type definition")





  `generated__hour_of_day`

  *   is optional

  *   Type: merged type ([Hour of day.](model-defs-properties-properties-hour-of-day.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-hour-of-day.md "airs_model#/$defs/Properties/properties/generated__hour_of_day")



  merged type ([Hour of day.](model-defs-properties-properties-hour-of-day.md))

  any of

  *   [Untitled integer in Item](model-defs-properties-properties-hour-of-day-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-hour-of-day-anyof-1.md "check type definition")





  `generated__minute_of_day`

  *   is optional

  *   Type: merged type ([Minute of day.](model-defs-properties-properties-minute-of-day.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-minute-of-day.md "airs_model#/$defs/Properties/properties/generated__minute_of_day")



  merged type ([Minute of day.](model-defs-properties-properties-minute-of-day.md))

  any of

  *   [Untitled integer in Item](model-defs-properties-properties-minute-of-day-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-minute-of-day-anyof-1.md "check type definition")





  `generated__month`

  *   is optional

  *   Type: merged type ([Month](model-defs-properties-properties-month.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-month.md "airs_model#/$defs/Properties/properties/generated__month")



  merged type ([Month](model-defs-properties-properties-month.md))

  any of

  *   [Untitled integer in Item](model-defs-properties-properties-month-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-month-anyof-1.md "check type definition")





  `generated__year`

  *   is optional

  *   Type: merged type ([Year](model-defs-properties-properties-year.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-year.md "airs_model#/$defs/Properties/properties/generated__year")



  merged type ([Year](model-defs-properties-properties-year.md))

  any of

  *   [Untitled integer in Item](model-defs-properties-properties-year-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-year-anyof-1.md "check type definition")





  `generated__season`

  *   is optional

  *   Type: merged type ([Season](model-defs-properties-properties-season.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-season.md "airs_model#/$defs/Properties/properties/generated__season")



  merged type ([Season](model-defs-properties-properties-season.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-season-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-season-anyof-1.md "check type definition")





  `generated__tltrbrbl`

  *   is optional

  *   Type: merged type ([The coordinates of the top left, top right, bottom right, bottom left corners of the item.](model-defs-properties-properties-the-coordinates-of-the-top-left-top-right-bottom-right-bottom-left-corners-of-the-item.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-the-coordinates-of-the-top-left-top-right-bottom-right-bottom-left-corners-of-the-item.md "airs_model#/$defs/Properties/properties/generated__tltrbrbl")



  merged type ([The coordinates of the top left, top right, bottom right, bottom left corners of the item.](model-defs-properties-properties-the-coordinates-of-the-top-left-top-right-bottom-right-bottom-left-corners-of-the-item.md))

  any of

  *   [Untitled array in Item](model-defs-properties-properties-the-coordinates-of-the-top-left-top-right-bottom-right-bottom-left-corners-of-the-item-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-the-coordinates-of-the-top-left-top-right-bottom-right-bottom-left-corners-of-the-item-anyof-1.md "check type definition")





  `generated__band_common_names`

  *   is optional

  *   Type: merged type ([List of the band common names.](model-defs-properties-properties-list-of-the-band-common-names.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-list-of-the-band-common-names.md "airs_model#/$defs/Properties/properties/generated__band_common_names")



  merged type ([List of the band common names.](model-defs-properties-properties-list-of-the-band-common-names.md))

  any of

  *   [Untitled array in Item](model-defs-properties-properties-list-of-the-band-common-names-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-list-of-the-band-common-names-anyof-1.md "check type definition")





  `generated__band_names`

  *   is optional

  *   Type: merged type ([List of the band names.](model-defs-properties-properties-list-of-the-band-names.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-list-of-the-band-names.md "airs_model#/$defs/Properties/properties/generated__band_names")



  merged type ([List of the band names.](model-defs-properties-properties-list-of-the-band-names.md))

  any of

  *   [Untitled array in Item](model-defs-properties-properties-list-of-the-band-names-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-list-of-the-band-names-anyof-1.md "check type definition")





  `generated__geohash2`

  *   is optional

  *   Type: merged type ([Geohash on the first two characters.](model-defs-properties-properties-geohash-on-the-first-two-characters.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-geohash-on-the-first-two-characters.md "airs_model#/$defs/Properties/properties/generated__geohash2")



  merged type ([Geohash on the first two characters.](model-defs-properties-properties-geohash-on-the-first-two-characters.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-geohash-on-the-first-two-characters-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-geohash-on-the-first-two-characters-anyof-1.md "check type definition")





  `generated__geohash3`

  *   is optional

  *   Type: merged type ([Geohash on the first three characters.](model-defs-properties-properties-geohash-on-the-first-three-characters.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-geohash-on-the-first-three-characters.md "airs_model#/$defs/Properties/properties/generated__geohash3")



  merged type ([Geohash on the first three characters.](model-defs-properties-properties-geohash-on-the-first-three-characters.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-geohash-on-the-first-three-characters-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-geohash-on-the-first-three-characters-anyof-1.md "check type definition")





  `generated__geohash4`

  *   is optional

  *   Type: merged type ([Geohash on the first four characters.](model-defs-properties-properties-geohash-on-the-first-four-characters.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-geohash-on-the-first-four-characters.md "airs_model#/$defs/Properties/properties/generated__geohash4")



  merged type ([Geohash on the first four characters.](model-defs-properties-properties-geohash-on-the-first-four-characters.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-geohash-on-the-first-four-characters-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-geohash-on-the-first-four-characters-anyof-1.md "check type definition")





  `generated__geohash5`

  *   is optional

  *   Type: merged type ([Geohash on the first five characters.](model-defs-properties-properties-geohash-on-the-first-five-characters.md))

  *   cannot be null

  *   defined in: [Item](model-defs-properties-properties-geohash-on-the-first-five-characters.md "airs_model#/$defs/Properties/properties/generated__geohash5")



  merged type ([Geohash on the first five characters.](model-defs-properties-properties-geohash-on-the-first-five-characters.md))

  any of

  *   [Untitled string in Item](model-defs-properties-properties-geohash-on-the-first-five-characters-anyof-0.md "check type definition")

  *   [Untitled null in Item](model-defs-properties-properties-geohash-on-the-first-five-characters-anyof-1.md "check type definition")



  Additional properties are allowed and do not have to follow a specific schema



  Reference this group by using

  ```json
  {"$ref":"airs_model#/$defs/Raster"}
  ```

  | Property        | Type     | Required | Nullable       | Defined by                                                                              |
  | :-------------- | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------- |
  | [type](#type-1) | `object` | Required | cannot be null | [Item](model-defs-rastertype.md "airs_model#/$defs/Raster/properties/type")             |
  | [path](#path)   | `string` | Required | cannot be null | [Item](model-defs-raster-properties-path.md "airs_model#/$defs/Raster/properties/path") |
  | [id](#id-1)     | `string` | Required | cannot be null | [Item](model-defs-raster-properties-id.md "airs_model#/$defs/Raster/properties/id")     |





  `type`

  *   is required

  *   Type: `object` ([RasterType](model-defs-rastertype.md))

  *   cannot be null

  *   defined in: [Item](model-defs-rastertype.md "airs_model#/$defs/Raster/properties/type")



  `object` ([RasterType](model-defs-rastertype.md))





  `path`

  *   is required

  *   Type: `string` ([Path](model-defs-raster-properties-path.md))

  *   cannot be null

  *   defined in: [Item](model-defs-raster-properties-path.md "airs_model#/$defs/Raster/properties/path")



  `string` ([Path](model-defs-raster-properties-path.md))





  `id`

  *   is required

  *   Type: `string` ([Id](model-defs-raster-properties-id.md))

  *   cannot be null

  *   defined in: [Item](model-defs-raster-properties-id.md "airs_model#/$defs/Raster/properties/id")



  `string` ([Id](model-defs-raster-properties-id.md))



  Reference this group by using

  ```json
  {"$ref":"airs_model#/$defs/RasterType"}
  ```

  | Property          | Type     | Required | Nullable       | Defined by                                                                                          |
  | :---------------- | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------- |
  | [source](#source) | `string` | Required | cannot be null | [Item](model-defs-rastertype-properties-source.md "airs_model#/$defs/RasterType/properties/source") |
  | [format](#format) | `string` | Required | cannot be null | [Item](model-defs-rastertype-properties-format.md "airs_model#/$defs/RasterType/properties/format") |





  `source`

  *   is required

  *   Type: `string` ([Source](model-defs-rastertype-properties-source.md))

  *   cannot be null

  *   defined in: [Item](model-defs-rastertype-properties-source.md "airs_model#/$defs/RasterType/properties/source")



  `string` ([Source](model-defs-rastertype-properties-source.md))





  `format`

  *   is required

  *   Type: `string` ([Format](model-defs-rastertype-properties-format.md))

  *   cannot be null

  *   defined in: [Item](model-defs-rastertype-properties-format.md "airs_model#/$defs/RasterType/properties/format")



  `string` ([Format](model-defs-rastertype-properties-format.md))



  Reference this group by using

  ```json
  {"$ref":"airs_model#/$defs/VariableType"}
  ```

  | Property | Type | Required | Nullable | Defined by |
  | :------- | :--- | :------- | :------- | :--------- |


pkgId: 2d4b69c71feec5cc7afeccb7d2eb214c1a1b0d26cac5ee28d1ad4420a9b6cd14
name: python-airspeed
arch: src
version: 0.6.0
epoch: 0
release: 1
url: https://github.com/purcell/airspeed/
rpm_license: BSD
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-airspeed-0.6.0-1.src.rpm
checksum_type: sha256
summary:
  Airspeed is a powerful and easy-to-use templating engine for Python that aims for a high level of compatibility with the popular Velocity library for Java.


pkgId: 7cc72f0aebe3e0ccfea363020f39469d89550fccdfdb8e65d01d2252aa775e4e
name: python-airspeed-ext
arch: src
version: 0.6.6
epoch: 0
release: 1
url: https://github.com/localstack/airspeed/
rpm_license: BSD
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-airspeed-ext-0.6.6-1.src.rpm
checksum_type: sha256
summary:
  Airspeed is a powerful and easy-to-use templating engine for Python that aims for a high level of compatibility with Velocity templates in AWS cloud services.


pkgId: 1b3a845d3d84e5b676e9953fdf9d1879b490722fc6b14c95180b32bb8aa043b6
name: python-airt-client
arch: src
version: 2023.3.0
epoch: 0
release: 1
summary: Python client for airt-service
url: https://github.com/airtai/airt-client
rpm_license: Creative Commons License
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-airt-client-2023.3.0-1.src.rpm
checksum_type: sha256
description:
  For full documentation, Please follow the below link:

  - <a href="https://docs.airt.ai" target="_blank">https://docs.airt.ai/</a>




  If you don't have the airt library already installed, please install it using pip.


  ```console
  pip install airt-client
  ```



  To access the airt service, you must first create a developer account. Please fill out the signup form below to get one:

  - [https://bit.ly/3hbXQLY](https://bit.ly/3hbXQLY)

  After successful verification, you will receive an email with the username and password for the developer account.

  Once you have the credentials, use them to get an access token by calling `Client.get_token` method. It is necessary to get an access token; otherwise, you won't be able to access all of the airt service's APIs. You can either pass the username, password, and server address as parameters to the `Client.get_token` method or store them in the environment variables **AIRT_SERVICE_USERNAME**, **AIRT_SERVICE_PASSWORD**, and **AIRT_SERVER_URL**

  In addition to the regular authentication with credentials, you can also enable multi-factor authentication (MFA) and single sign-on (SSO) for generating tokens.

  To help protect your account, we recommend that you enable multi-factor authentication (MFA). MFA provides additional security by requiring you to provide unique verification code (OTP) in addition to your regular sign-in credentials when performing critical operations.

  Your account can be configured for MFA in just two easy steps:

  1. To begin, you need to enable MFA for your account by calling the `User.enable_mfa` method, which will generate a QR code. You can then
  scan the QR code with an authenticator app, such as Google Authenticator and follow the on-device instructions to finish the setup in your smartphone.

  2. Finally, activate MFA for your account by calling `User.activate_mfa` and passing the dynamically generated six-digit verification code from your
  smartphone's authenticator app.

  You can also disable MFA for your account at any time by calling the method `User.disable_mfa` method.

  Single sign-on (SSO) can be enabled for your account in three simple steps:

  1. Enable the SSO for a provider by calling the `User.enable_sso` method with the SSO provider name and an email address. At the moment,
  we only support **"google"** and **"github"** as SSO providers. We intend to support additional SSO providers in future releases.

  2. Before you can start generating new tokens with SSO, you must first authenticate with the SSO provider. Call the `Client.get_token` with
  the same SSO provider you have enabled in the step above to generate an SSO authorization URL. Please copy and paste it into your
  preferred browser and complete the authentication process with the SSO provider.

  3. After successfully authenticating with the SSO provider, call the `Client.set_sso_token` method to generate a new token and use it automatically
  in all future interactions with the airt server.

  For more information, please check:

  - [Tutorial](https://docs.airt.ai/Tutorial/) with more elaborate example, and

  - [API](https://docs.airt.ai/API/client/Client/) with reference documentation.

  Here's a minimal example showing how to use airt services to train a model and make predictions.

  In the below example, the username, password, and server address are stored in **AIRT_SERVICE_USERNAME**, **AIRT_SERVICE_PASSWORD**, and **AIRT_SERVER_URL** environment variables.





  ```



  import os


  os.environ["AIRT_SERVICE_USERNAME"] = "johndoe"
  os.environ["AIRT_SERVICE_PASSWORD"] = os.environ["AIRT_SERVICE_SUPER_USER_PASSWORD"]
  ```


  ```

  from airt.client import Client, DataSource, DataBlob


  Client.get_token()
  ```




  ```




  data_blob = DataBlob.from_s3(
      uri="s3://test-airt-service/ecommerce_behavior_csv"
  )


  data_blob.progress_bar()



  data_source = data_blob.to_datasource(
      file_type="csv",
      index_column="user_id",
      sort_by="event_time"
  )


  data_source.progress_bar()



  print(data_source.head())
  ```

      100%|██████████| 1/1 [01:00<00:00, 60.62s/it]
      100%|██████████| 1/1 [00:35<00:00, 35.39s/it]


                                event_time event_type  product_id  \
      user_id
      10300217   2019-11-06 06:51:52+00:00       view    26300219
      253299396  2019-11-05 21:25:44+00:00       view     2400724
      253299396  2019-11-05 21:27:43+00:00       view     2400724
      272811580  2019-11-05 19:38:48+00:00       view     3601406
      272811580  2019-11-05 19:40:21+00:00       view     3601406
      288929779  2019-11-06 05:39:21+00:00       view    15200134
      288929779  2019-11-06 05:39:34+00:00       view    15200134
      310768124  2019-11-05 20:25:52+00:00       view     1005106
      315309190  2019-11-05 23:13:43+00:00       view    31501222
      339186405  2019-11-06 07:00:32+00:00       view     1005115

                         category_id              category_code  \
      user_id
      10300217   2053013563424899933                       None
      253299396  2053013563743667055    appliances.kitchen.hood
      253299396  2053013563743667055    appliances.kitchen.hood
      272811580  2053013563810775923  appliances.kitchen.washer
      272811580  2053013563810775923  appliances.kitchen.washer
      288929779  2053013553484398879                       None
      288929779  2053013553484398879                       None
      310768124  2053013555631882655     electronics.smartphone
      315309190  2053013558031024687                       None
      339186405  2053013555631882655     electronics.smartphone

                                     brand    price  \
      user_id
      10300217                     sokolov    40.54
      253299396                      bosch   246.85
      253299396                      bosch   246.85
      272811580                       beko   195.60
      272811580                       beko   195.60
      288929779                      racer    55.86
      288929779                      racer    55.86
      310768124                      apple  1422.31
      315309190  dobrusskijfarforovyjzavod   115.18
      339186405                      apple   915.69

                                         user_session
      user_id
      10300217   d1fdcbf1-bb1f-434b-8f1a-4b77f29a84a0
      253299396  b097b84d-cfb8-432c-9ab0-a841bb4d727f
      253299396  b097b84d-cfb8-432c-9ab0-a841bb4d727f
      272811580  d18427ab-8f2b-44f7-860d-a26b9510a70b
      272811580  d18427ab-8f2b-44f7-860d-a26b9510a70b
      288929779  fc582087-72f8-428a-b65a-c2f45d74dc27
      288929779  fc582087-72f8-428a-b65a-c2f45d74dc27
      310768124  79d8406f-4aa3-412c-8605-8be1031e63d6
      315309190  e3d5a1a4-f8fd-4ac3-acb7-af6ccd1e3fa9
      339186405  15197c7e-aba0-43b4-9f3a-a815e31ade40





  ```


  from datetime import timedelta

  model = data_source.train(
      client_column="user_id",
      target_column="event_type",
      target="*purchase",
      predict_after=timedelta(hours=3),
  )


  model.progress_bar()



  print(model.evaluate())
  ```

      100%|██████████| 5/5 [00:00<00:00, 126.62it/s]

                  eval
      accuracy   0.985
      recall     0.962
      precision  0.934








  ```


  predictions = model.predict()


  predictions.progress_bar()



  print(predictions.to_pandas().head())
  ```

      100%|██████████| 3/3 [00:10<00:00,  3.38s/it]

                    Score
      user_id
      520088904  0.979853
      530496790  0.979157
      561587266  0.979055
      518085591  0.978915
      558856683  0.977960


pkgId: e08a06738fad5e73b6939d411c1666e5d2f273bb90f9b26d1ea8bc51a7673d44
name: python-airt-utils
arch: src
version: 0.1.7
epoch: 0
release: 1
summary: Utilities for experiment-centric AI Red Teaming workflows
url: https://pypi.org/project/airt-utils/
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-airt-utils-0.1.7-1.src.rpm
checksum_type: sha256
description:
  For research-centric AI Red Teaming operations, there are best practices we can borrow from the evolution of MLOps. For example, both workflows involve multiple researchers focused on optimizations against open-ended research questions. At some point, the work from these researchers must be compared, potentially aggregated, and the best solution iterated upon. Often there is also a reporting phase where stakeholders need to be able to access R&D artifacts.

  `airt_utils` is a collection of Python utilities for tracking AI Red Teaming experiments and operations, starting with the `airt_run` decorator that seamlessly integrates your functions with MLflow. It provides automatic logging of parameters, metrics, and artifacts, supporting both synchronous and asynchronous functions. This makes it ideal for a wide range of machine learning and data science workflows, particularly in the context of security research.



  Before using `airt_utils`, you need to have MLflow running. MLflow is an open-source platform for managing the end-to-end machine learning lifecycle, including experimentation, reproducibility, and deployment.

  To get started with MLflow:

  1. Install MLflow:
     ```
     pip install mlflow
     ```

  2. Start the MLflow tracking server:
     ```
     mlflow server --host 0.0.0.0 --port 5000
     ```

  This will start the MLflow UI, which you can access at `http://localhost:5000`.

  For more information on MLflow and its setup, refer to the [MLflow documentation](https://www.mlflow.org/docs/latest/index.html).

  MLflow's purpose is to help manage the machine learning lifecycle, including experimentation, reproducibility, and deployment. In the context of AI security research, it can help track and compare different attack or defense strategies, model vulnerabilities, and the effectiveness of various countermeasures.



  - 🚀 Easy integration with MLflow through the simple `airt_run` decorator
  - 🔄 Support for both synchronous and asynchronous functions
  - ⏱️ Optional timeout functionality
  - 📊 Automatic logging of function parameters and return values
  - 📁 Artifact logging support
  - 🏷️ Custom tagging for runs
  - 📈 Support for custom and system metrics
  - 🔁 Retry mechanism for improved reliability
  - 🛠️ Highly configurable to suit various use cases



  Install `airt_utils` using pip:

  ```bash
  pip install airt_utils
  ```



  Here's an example of how to use the `airt_run` decorator in the context of AI security research:

  ```python
  from airt_utils import airt_run
  import numpy as np
  from sklearn.model_selection import train_test_split
  from sklearn.svm import SVC
  from sklearn.metrics import accuracy_score

  @airt_run(
      experiment_name="adversarial_example_generation",
      params=["epsilon", "n_samples"],
      artifacts=["adversarial_examples.npy"],
  )
  def generate_adversarial_examples(epsilon, n_samples):
      
      model = load_pretrained_model()

      
      X = np.random.rand(n_samples, 784)  # Assuming MNIST-like data
      y = np.random.randint(0, 10, n_samples)

      
      X_adv = X + epsilon * np.sign(model.gradient(X, y))

      
      np.save("adversarial_examples.npy", X_adv)

      
      y_pred = model.predict(X_adv)
      accuracy = accuracy_score(y, y_pred)

      return accuracy

  result = generate_adversarial_examples(epsilon=0.1, n_samples=1000)
  print(f"Model accuracy on adversarial examples: {result}")
  ```

  This example will:
  1. Create an MLflow experiment named "adversarial_example_generation"
  2. Log the parameters `epsilon` and `n_samples`
  3. Generate adversarial examples using the Fast Gradient Sign Method
  4. Save the adversarial examples as an artifact
  5. Evaluate and log the model's accuracy on these adversarial examples





  `airt_run` supports async functions, which can be useful for distributed attacks or parallel processing:

  ```python
  import asyncio
  from airt_utils import airt_run

  @airt_run(
      experiment_name="distributed_attack_simulation",
      timeout_seconds=300
  )
  async def distributed_attack():
      
      tasks = [
          asyncio.create_task(sql_injection_attack()),
          asyncio.create_task(xss_attack()),
          asyncio.create_task(csrf_attack())
      ]
      results = await asyncio.gather(*tasks)
      return {
          "sql_injection_success": results[0],
          "xss_success": results[1],
          "csrf_success": results[2]
      }

  result = asyncio.run(distributed_attack())
  print(result)
  ```



  You can define custom metrics to track specific aspects of your security experiments:

  ```python
  from airt_utils import airt_run

  def attack_success_rate(result):
      return sum(result['success']) / len(result['success'])

  @airt_run(
      experiment_name="model_robustness_evaluation",
      custom_metrics={"success_rate": attack_success_rate}
  )
  def evaluate_model_robustness(model, attack_samples):
      results = []
      for sample in attack_samples:
          prediction = model.predict(sample)
          results.append({
              "success": prediction != sample.true_label,
              "confidence": model.predict_proba(sample).max()
          })
      return results

  attack_samples = load_attack_samples()  # Assume we have this function
  model = load_target_model()  # Assume we have this function
  results = evaluate_model_robustness(model, attack_samples)
  ```

  This will log the success rate of the attacks as a custom metric.



  `airt_run` offers various configuration options:

  - `experiment_name`: Name of the MLflow experiment
  - `params`: List of function parameters to log
  - `artifacts`: List of files or directories to log as artifacts (protip: log entire configuration directories and debug logs for target applications)
  - `tracking_uri`: MLflow tracking server URI
  - `timeout_seconds`: Maximum execution time for the function
  - `tags`: Dictionary of tags to apply to the run
  - `log_system_metrics`: Whether to log system metrics
  - `retry_attempts`: Number of retry attempts for MLflow operations
  - `retry_delay`: Delay between retry attempts
  - `custom_metrics`: Dictionary of custom metrics to compute and log

  These configuration options allow you to tailor `airt_utils` to your specific AI security research needs, ensuring comprehensive tracking and analysis of your experiments.


pkgId: 8c5fb5300b52dfafd6bc81b91a6abf02324c6ed5bba4633b5ec166ea56d6e5f2
name: python-airtable-cacher
arch: src
version: 1.2.5
epoch: 0
release: 1
url: https://github.com/bawpcwpn/AirtableCacher
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-airtable-cacher-1.2.5-1.src.rpm
checksum_type: sha256
summary:
  Utility for caching api responses from the airtable-python-wrapper based on airtable-caching by rmountjoy

description:
  This plugin is fork of the work done by Ron Mountjoy on `Airtable Caching`
  https://github.com/rmountjoy92/AirtableCaching


  First you must setup a recurring script that will cache the table.

  ```
  from airtable_cacher import Base

  airtable = Base(<AIRTABLE_BASE_ID>, <AIRTABLE_API_KEY>)

  """
  Main Function
  """

  airtable.cache_table(<AIRTABLE_PRODUCTS_TABLE>)

  ```

  You can optionally supply a third argument to `Base()` for setting the json folder like so:

  ```
  from airtable_cacher import Base

  airtable = Base(<AIRTABLE_BASE_ID>, <AIRTABLE_API_KEY>, "my_json_folder")
  ```



  If you'd like to cache images, you can do so by supplying an optional fourth argument



  ```
  from airtable_cacher import Table

  products_table = Table(<AIRTABLE_BASE_ID>,<AIRTABLE_PRODUCTS_TABLE>)
  ```

  If you have supplied a custom JSON folder path in the caching, you supply that as an optional third argument in
   `Table()`

  ```
  from airtable_cacher import Table

  products_table = Table(<AIRTABLE_BASE_ID>,<AIRTABLE_PRODUCTS_TABLE>, "my_json_folder")
  ```

  To get all records then use

  ```
  records = products_table.all()
  ```


pkgId: 029114b9873c65222a70aee7bb19733f51223ef5719267cc509405af6ec7cfc7
name: python-airtable-pack
arch: src
version: 0.0.9
epoch: 0
release: 1
summary: Python wrapper for Airtable Pack.
url: https://pypi.org/project/airtable_pack/
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-airtable-pack-0.0.9-1.src.rpm
checksum_type: sha256
description:
  - https://support.airtable.com/docs/taking-and-restoring-base-snapshots
  - https://support.airtable.com/docs/es/using-field-and-table-editing-permissions
  - https://airtable.com/developers/web/api/model/field-type


  1. Desde Python se genera la estructura de las tarjetas.
  2. Se crean las tarjetas desde código.
  3. Se editan las tarjetas manualmente.
  4. (Si se puede) Desde Python tomamos un Snapshot, sino manualmente.
  5. Volver al punto 3).

  - Si hubiera problemas, podemos restaurar versiones anteriores.
  - Tenemos nivel de registro del usuario a una tabla específica y campos específicos.


pkgId: cb14812762093af4900af33d7330aec953a82bc7f643eba812bdb08c6002d7b6
name: python-airtable-pg-sync
arch: src
version: 0.0.47
epoch: 0
release: 1
summary: Sync Airtable bases to a Postgres schemas in real time
url: https://github.com/benurwin/airtable_pg_sync
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-airtable-pg-sync-0.0.47-1.src.rpm
checksum_type: sha256
description:
  The goal of this library is to provide an out-of-the-box solution for replicating
  an entire Airtable base in a Postgres schema. There are two modes of operation:

  - **One-off-sync**: This mode will replicate the Airtable base in the specified Postgres schema
    and then exit. This is useful for creating snapshots of the base for analysis or for storage as a backup.
  - **Perpetual sync**: This mode will replicate the Airtable base in the specified Postgres schema
    and then continue to watch for changes in the base. When a change is detected, the
    change will be applied to the Postgres schema. This is useful for creating a
    replica of the base that can be used for analysis in real time.


  This library will produce a Postgres table and view for each of the tables in the specified Airtable base.
  The table will take the Airtable table id for its name and the field ids for its column names. The view will have the
  same name as the Airtable table and the column names will be the same as the Airtable column names.
  For most analysis use cases it makes sense to use the view as it is more readable, but for applications requiring
  robustness with respect to column name changes the table should be used.




  To install the library, run the following command:

  ```bash
  pip install airtable-pg-sync
  ```



  To use this library, you will need to create a personal access token in Airtable. This
  token will need to have the following scopes:

  - data.records:read
  - schema.bases:read
  - webhook:manage

  You will also need to give the Postgres user that you are using read and write access to the schema
  you are syncing to.



  To use the library, you will need to create a config file. The config file defines
  all the parameters that are needed to connect to Airtable and Postgres, as well as how
  your program will listen for changes. The file must be in YAML format and must contain
  the following fields:

  ```yaml
  AIRTABLE_PG_SYNC:
    REDUCED_MEMORY: # boolean, if true will use less memory but will be slower when initially syncing tables
    DB_HOST: # Postgres host
    DB_PORT: # Postgres port
    DB_USER: # Postgres user
    DB_PASSWORD: # Postgres password
    DB_NAME: # Postgres database name
    AIRTABLE_PAT: # Airtable personal access token
    LISTENER_PORT: # The port to listen for change notifications on
    WEBHOOK_URL: # The url that Airtable will send change notifications to
      REPLICATION_NAME_ONE: # Unique dummy identifier for the replication
          BASE_ID: # Airtable base id to sync
          SCHEMA_NAME: # Postgres schema name
      REPLICATION_NAME_TWO: # Unique dummy identifier for the replication
          BASE_ID: # Airtable base id to sync
          SCHEMA_NAME: # Postgres schema name
  ```

  The library can be used in two ways:

  1. As a command line tool

  To trigger a one-time sync, run the following command:

  ```bash
  airtable-pg-sync one-time-sync --config /path/to/config.yml
  ```

  To trigger a perpetual sync, run the following command:

  ```bash
  airtable-pg-sync perpetual-sync --config /path/to/config.yml
  ```

  2. As a python library

  To trigger a sync from within a python program, run the following code:

  ```python
  from airtable_pg_sync import Sync

  Sync(config_path="/path/to/config.yml", perpetual=True / False).run()
  ```




  When testing this library for your use case the [ngrok](https://ngrok.com/) service is very useful. It allows you to listen
  for requests sent over the internet to your PC (ie the webhook POST requests).

  For deployment, it is recommended that you run the library in an AWS EC2 or ECS type service.
  When using reduced memory mode, an instance with 0.25 vCPU and 0.5 GB of memory will be sufficient.
  WHen not using reduced memory mode, the instance size will depend on the size of your data set.



  If you find a bug or have a feature request, please open an issue
  on [GitHub](https://github.com/benurwin/airtable_pg_sync/issues).
  Any contributions are welcome and appreciated. If you would like to
  contribute, please open a pull request on [GitHub](https://github.com/benurwin/airtable_pg_sync/pulls).



  - Add support for other databases
  - Add support for Postgres -> Airtable sync



  This library is licensed under the MIT License. See the
  [LICENSE](https://github.com/benurwin/airtable_pg_sync/blob/main/LICENSE) file

rpm_license:
  Copyright 2023 Benjamin Urwin  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.  Join Us


pkgId: dfc89a9b435e4150810b5a8c831347a2dba6c10c773450106ec42f0b8392af6c
name: python-airtable-python-wrapper
arch: src
version: 0.15.3
epoch: 0
release: 1
summary: Python API Wrapper for the Airtable API
url: https://github.com/gtalarico/airtable-python-wrapper
rpm_license: The MIT License (MIT)
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-airtable-python-wrapper-0.15.3-1.src.rpm
checksum_type: sha256
description:
  [![Build Status](https://travis-ci.com/gtalarico/airtable-python-wrapper.svg?branch=master)](https://travis-ci.com/gtalarico/airtable-python-wrapper)
  [![PyPI - Downloads](https://img.shields.io/pypi/dm/airtable-python-wrapper.svg?label=pypi%20downloads)](https://pypi.org/project/airtable-python-wrapper/)
  [![Coverage Status](https://coveralls.io/repos/github/gtalarico/airtable-python-wrapper/badge.svg?branch=master)](https://coveralls.io/github/gtalarico/airtable-python-wrapper?branch=master)
  [![Documentation Status](https://readthedocs.org/projects/airtable-python-wrapper/badge/?version=latest)](http://airtable-python-wrapper.readthedocs.io/en/latest/?badge=latest)

  Airtable API Client Wrapper for Python

  ![project-logo](https://github.com/gtalarico/airtable-python-wrapper/blob/master/docs/source/_static/logo.png)



  ```
  pip install airtable-python-wrapper
  ```



  Full documentation here:

  http://airtable-python-wrapper.readthedocs.io/



  Below are some of the methods available in the wrapper.

  For the full list and documentation visit the [docs](http://airtable-python-wrapper.readthedocs.io/)

  You can see the wrapper in action in this [Jupyter Notebook](https://github.com/gtalarico/airtable-python-wrapper/blob/master/Airtable.ipynb).

  ```
  airtable = Airtable('base_id', 'table_name')

  airtable.get_all(view='MyView', maxRecords=20)

  airtable.insert({'Name': 'Brian'})

  airtable.search('Name', 'Tom')

  airtable.update_by_field('Name', 'Tom', {'Phone': '1234-4445'})

  airtable.delete_by_field('Name', 'Tom')

  ```


  [MIT](https://opensource.org/licenses/MIT)



  * Adds escaping formula field references #120

  * Added Batch update method


  * Fix: [batch delete](https://github.com/gtalarico/airtable-python-wrapper/pull/100)


  * **Breaking**: Drop Api config from ENV variable - use `api_key` arg instead
  * **Breaking**: Drop Python 2 / IronPython Support
  * Feature: On HTTP Errors, Raise Original Exception, but with Helpful Errors added
  * Fix: #86 formulas with string values


  * Removed: `mirror()` method.
  * Feature: Configurable request timeout


  * Fixed: Python 2 compatibility issues
  * Start CI testing on all supported Python versions
  * **Breaking**: Drop implicit support for Python 3.4, officially support 3.7 and 3.8.


  * Fixed: Rewrote tests
  * Fixed: Improve CI and deployment


  * Fixed: Add sdist and universal for 2.7 dist
  * Fixed: Long dist set to markdown


  * Feature: Merged PR#17 - Added typecast to update, update_by_field, replace, replace_by_field


  * Feature: Added typcase option to batch_insert


  * Feature: Merged PR#17 - typecase kwarg


  * Feature: Better exception message for 422 (Issue #16)
  * Fix: 2.7 Compat with sys.implementation


  * Docs: Revised Docs strings to show kebab case kwargs
  * Fix: Url Escape (PR#1)


  * Docs: New Documentation on Parameter filters Docs
  * Docs: More documentation and examples.
  * Feature: Search now uses filterByFormula
  * Added Formula Generator


  * Removed Unencoded Debug Msg due to IronPython Bug #242


  * Merge Fix


  * Moved version to sep file to fix setup.py error
  * Removed urlencode import
  * Added Explicit Raise for 422 errors with Decoded Urls


  * Feature: Added airtable.get() method to retrieve record
  * Fix: sort/field string input to allow sting or list
  * Fix: AirtableAuth Docs
  * Fix: Keyargs Docs


  * Bugfix: Fix Setup to install six.py
  * Bugfix: Fix AitableAuth Docs


  * Implemented Sort Filter
  * Implemented FilterByFormula
  * Implemented all param filters as classes
  * Added Aliases for Parameters
  * Renamed get() to get_iter()




  * Added replace()
  * Added mirror()


  * Initial Work


pkgId: 89907563ea1a6982c5ac37da8d643ba1194c352588c9867d415673d939ed81a8
name: python-airtest-mobileauto
arch: src
version: 1.3.25
epoch: 0
release: 1
url: https://github.com/cndaqiang/airtest_mobileauto
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-airtest-mobileauto-1.3.25-1.src.rpm
checksum_type: sha256
summary:
  A robust, object-oriented, multi-process mobile app control framework based on AirTest, designed for stable and compatible debugging and automation of devices and apps. Ideal for tasks such as game automation in titles like Honor of Kings, with enhanced stability features including connection checks, automatic retries on failure, and automatic restarts for continuous operation.

description:
  AirTest Mobile Automation is an object-oriented, multi-process control framework for mobile apps based on the AirTest framework. It is designed for stability and compatibility, making it ideal for automating tasks in games like Honor of Kings.



  * **Enhanced Stability**: This framework enhances the reliability of testing and automation by implementing rigorous connection status checks and intelligent automatic reconnection mechanisms. Instead of throwing errors upon failure, it encapsulates AirTest functions to attempt reconnections, ensuring continuous operation even in the face of transient network issues or screenshot retrieval failures. In rare cases, such as with iOS devices, it may prompt for a physical reconnect of the device to be recognized by `tidevice list`. Additionally, it addresses and corrects issues with the `start_app` function that could occur on certain Android systems, providing a smoother and more resilient automation experience.
  * **Automated Operation**: Capable of fully automated processes with unattended operation. In case of errors, it automatically restarts the app or the control endpoint, such as Docker or an Android emulator.
  * **Time Management**: Utilizes the UTC/GMT+08:00 time zone for task scheduling aligned with Chinese game refresh cycles.
  * **Formatted Output**: Displays information in a formatted manner, e.g.,  `[MM-DD HH:MM:SS] info`.





  Handles device management in an object-oriented approach, supporting various clients and control endpoints.

  | Clients | Control Endpoints | Management Capabilities |
  |---------|-------------------|-------------------------|
  | [BlueStacks](https://www.bluestacks.com/download.html) / [LDPlayer](https://www.ldplayer.net/)/ [MuMu](https://mumu.163.com/) | Windows | Start, stop, and restart emulators |
  | [Docker](https://hub.docker.com/r/redroid/redroid) | Linux | Start, stop, and restart containers |
  | iOS | Mac | Reconnect with tidevice, restart iOS |
  | USB-connected Android phones | ALL | Reboot Android system |
  | WIFI-connected phones | ALL | Hot reboot Android system |



  Manages the opening, stopping, and restarting of apps.



  * A utility for multi-process support based on the file system, including synchronization, broadcasting, file management, and enhanced time management.
  * Utilizes files and dictionaries to store and retrieve image coordinates, reducing the time to locate element coordinates repeatedly. It also allows for selecting specific positions, such as the least proficient hero in Honor of Kings based on proficiency.



  Below are some examples of development scripts that demonstrate the capabilities of the project.

  - An automation script for [Honor of Kings](https://github.com/cndaqiang/WZRY) .
  - Automate daily sign-ins and claim gift packages on Android with [autotask_android](https://github.com/cndaqiang/autotask_android).




  The historical versions of this script, namely [WZRY_AirtestIDE_XiaoMi11@cndaqiang](https://github.com/cndaqiang/WZRY_AirtestIDE_XiaoMi11), [WZRY_AirtestIDE_emulator@cndaqiang](https://github.com/cndaqiang/WZRY_AirtestIDE_emulator), and [WZRY@cndaqiang](https://github.com/cndaqiang/WZRY) have also been instrumental in the development process.



  This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.



  &copy; 2024 cndaqiang. All rights reserved.


pkgId: 88118f6e0369262df0e6f8926938f52f01079e76cc952b45d791f6856ec0d3d4
name: python-airtestProject
arch: src
version: 0.2.41
epoch: 0
release: 1
summary: please add a summary manually as the author left a blank one
url: https://pypi.org/project/airtestProject/
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-airtestProject-0.2.41-1.src.rpm
checksum_type: sha256
description:
  pip inatsll airtestProject 即可下载安装。

  最好用的airtest二次封装。

  三七出品必属精品。

  使用封装好的auto_setup需要在根目录下创建文件夹log和reports

  需要在跟目录文件夹下创建images

  状态机执行正在安排


pkgId: 2c9841395eac514336968720e9a7b55cfa1caf7bf8a559377bc0426af0eda960
name: python-airthings
arch: src
version: 3.2.0
epoch: 0
release: 1
summary: Fetch sensor measurements from Airthings devices
url: https://github.com/kotlarz/airthings
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-airthings-3.2.0-1.src.rpm
checksum_type: sha256
description:
  ``airthings`` is a simple python package that contains methods to
  communicate with Airthings[1] devices. The package utilizies bluepy[2]
  for the communication between python and the devices. The package
  features can be found below.
  -  [1] https://airthings.com/
  -  [2] https://github.com/IanHarvey/bluepy
  *Note: Some features are currently undocumented, and parts are
  untested/not yet implemented.*


pkgId: da1b87ab10000bc7b6e3ae39e452df28b92dc61b102f77bc81172ee747afff3b
name: python-airthings-ble
arch: src
version: 0.9.1
epoch: 0
release: 1
summary: Manage Airthings BLE devices
url: https://github.com/Airthings/airthings-ble
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-airthings-ble-0.9.1-1.src.rpm
checksum_type: sha256
description:
  Library to control Airthings devices through BLE, primarily meant to be used in
  the [Home Assistant integration](https://www.home-assistant.io/integrations/airthings_ble/).

  The integration supports the following devices:

  - [Wave Plus](https://www.airthings.com/en/wave-plus)
  - [Wave Mini](https://www.airthings.com/en/wave-mini)
  - [Wave Radon](https://www.airthings.com/en/wave-radon)
  - Wave Gen 1

  Although some other devices have BLE capabilities, those devices use BLE for onboarding and configuration.
  It is not possible to fetch sensor data using this library.



  Prerequisites:

  - [Python](https://www.python.org/downloads/) with version 3.11 that is required by Home Assistant ([docs](https://developers.home-assistant.io/docs/development_environment?_highlight=python&_highlight=versi#manual-environment) or [reference](https://github.com/home-assistant/architecture/blob/master/adr/0002-minimum-supported-python-version.md))
  - [Poetry](https://python-poetry.org/docs/#installation)

  Install dependencies:

  ```bash
  poetry install
  ```

  Run tests:

  ```bash
  poetry run pytest
  ```

  See [this wiki page](https://github.com/Airthings/airthings-ble/wiki/Testing-with-Home-Assistant) for more details
  on how to test the library with HA.



  This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.


pkgId: 598ff254643d6e39d8965041bcc486196822b61885cd71a4430672f6246017d1
name: python-airtiler
arch: src
version: 2.1.7
epoch: 0
release: 1
url: https://github.com/mnboos/airtiler
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-airtiler-2.1.7-1.src.rpm
checksum_type: sha256
summary:
  The airtiler generates training / test data for neural networks by downloading buildings from vector data from OpenStreetMap and the corresponding satellite images from Microsoft Bing Maps.

description:
  |Build Status|
  The airtiler generates training / test data for neural networks by
  downloading buildings from vector data from OpenStreetMap and the
  corresponding satellite images from Microsoft Bing Maps.
  It then generates binary masks from the vector data which can be used
  for example for instance segmentation.


pkgId: 926ee478c6e1ced7583be13c2bcd4fb0c28b3937435fd9530c190e5c2da5b6e4
name: python-airton_ac
arch: src
version: 3.0.0
epoch: 0
release: 1
summary: Control an Airton AC device over LAN.
url: https://github.com/gpajot/airton-ac
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-airton_ac-3.0.0-1.src.rpm
checksum_type: sha256
description:
  [![tests](https://github.com/gpajot/airton-ac/actions/workflows/test.yml/badge.svg?branch=main&event=push)](https://github.com/gpajot/airton-ac/actions/workflows/test.yml?query=branch%3Amain+event%3Apush)
  [![version](https://img.shields.io/pypi/v/airton_ac?label=stable)](https://pypi.org/project/airton_ac/)
  [![python](https://img.shields.io/pypi/pyversions/airton_ac)](https://pypi.org/project/airton_ac/)

  Control an Airton AC device over LAN.
  This requires having the [wifi module](https://eu.airton.shop/en/products/kit-module-wifi-pour-climatiseurs-airton-en-wifi-ready).


  - asynchronous methods and transport
  - persistent communication to the device
  - automatic remote device state updates (remotes can still be used)
  - configurable buffering for subsequent updates
  - constraints between device commands
  - Domoticz plugin using a dedicated thread


  See [local tuya requirements](https://github.com/gpajot/local-tuya#requirements) first to find device information.

  Example usage:
  ```python
  from local_tuya import DeviceConfig, ProtocolConfig
  from airton_ac import ACDevice, ACFanSpeed


  async with ACDevice(DeviceConfig(ProtocolConfig("{id}", "{address}", b"{key}"))) as device:
      await device.switch(True)
      await device.set_speed(ACFanSpeed.L2)
      await device.switch(False)
  ```


  The plugin requires having fetched device information using instructions above.
  Make sure to read [plugin instructions](https://www.domoticz.com/wiki/Using_Python_plugins) first.
  > 💡 The Domoticz version should be `2022.1` or higher.

  ```shell
  python -m pip install --upgrade airton-ac[domoticz]
  python -m airton_ac.domoticz.install
  ```
  Domoticz path defaults to `~/domoticz` but you can pass a `-p` option to the second command to change that:
  ```shell
  python -m airton_ac.domoticz.install -p /some/other/path
  ```

  Restart Domoticz and create a new Hardware using `Tuya Airton AC`. Fill in device information and add.
  The hardware will create up to 5 devices to control the fan (all prefixed with hardware name):
  - `power`: to turn on or off
  - `set point`: to set the target temperature
  - `temperature`: to record curent temperature as measured by the unit
  - `mode`: to control operating mode
  - `fan`: to control fan speed
  - `eco`: toggle low heat when heating and eco-mode when cooling
  - `light`: toggle display on the unit
  - `swing`: toggle swing mode
  - `sleep`: toggle sleep mode
  - `health`: toggle health mode

  You can customize the devices you want added in the hardware page.

  All device names and levels can be changed once added as only IDs are used internally.


pkgId: 29150f23256c18b5d664ed5885c0221b8af5d8192a7e1193fbb117c7434e852e
name: python-airtop
arch: src
version: 0.0.26
epoch: 0
release: 1
summary: SDK for Airtop cloud browsers
url: https://pypi.org/project/airtop/
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-airtop-0.0.26-1.src.rpm
checksum_type: sha256
description:
  [![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fairtop-ai%2Fairtop-python-sdk)
  [![pypi](https://img.shields.io/pypi/v/airtop)](https://pypi.python.org/pypi/airtop)

  The Airtop Python library provides convenient access to the Airtop API from Python.



  ```sh
  pip install airtop
  ```



  A full reference for this library is available [here](./reference.md).



  Instantiate and use the client with the following:

  ```python
  from airtop import Airtop

  client = Airtop(
      api_key="YOUR_API_KEY",
  )
  client.sessions.create()
  ```



  The SDK also exports an `async` client so that you can make non-blocking calls to our API.

  ```python
  import asyncio

  from airtop import AsyncAirtop

  client = AsyncAirtop(
      api_key="YOUR_API_KEY",
  )


  async def main() -> None:
      await client.sessions.create()


  asyncio.run(main())
  ```



  When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
  will be thrown.

  ```python
  from airtop.core.api_error import ApiError

  try:
      client.sessions.create(...)
  except ApiError as e:
      print(e.status_code)
      print(e.body)
  ```



  The SDK supports streaming responses, as well, the response will be a generator that you can loop over.

  ```python
  from airtop import Airtop

  client = Airtop(
      api_key="YOUR_API_KEY",
  )
  response = client.sessions.events(
      id="string",
  )
  for chunk in response:
      yield chunk
  ```





  The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
  as the request is deemed retriable and the number of retry attempts has not grown larger than the configured
  retry limit (default: 2).

  A request is deemed retriable when any of the following HTTP status codes is returned:

  - [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
  - [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
  - [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)

  Use the `max_retries` request option to configure this behavior.

  ```python
  client.sessions.create(..., request_options={
      "max_retries": 1
  })
  ```



  The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.

  ```python

  from airtop import Airtop

  client = Airtop(
      ...,
      timeout=20.0,
  )



  client.sessions.create(..., request_options={
      "timeout_in_seconds": 1
  })
  ```



  You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies
  and transports.
  ```python
  import httpx
  from airtop import Airtop

  client = Airtop(
      ...,
      httpx_client=httpx.Client(
          proxies="http://my.test.proxy.example.com",
          transport=httpx.HTTPTransport(local_address="0.0.0.0"),
      ),
  )
  ```



  While we value open-source contributions to this SDK, this library is generated programmatically.
  Additions made directly to this library would have to be moved over to our generation code,
  otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
  a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
  an issue first to discuss with us!

  On the other hand, contributions to the README are always very welcome!


pkgId: e3129ef42156f6f43a98a758e6cc198cbeef124af94e8923fc7996a51057b438
name: python-airtop-langgraph-helpers
arch: src
version: 0.1.1
epoch: 0
release: 1
url: https://github.com/airtop-ai/airtop_langgraph_helpers
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-airtop-langgraph-helpers-0.1.1-1.src.rpm
checksum_type: sha256
summary:
  A small package containing class definitions and helpers for integrating Airtop into your LangGraph application

description:
  A small package containing class definitions and helpers for integrating Airtop into your LangGraph application.


pkgId: 8382f79e25dc32daf8d33123767e038399c9c36c6102d71236660573ece2b221
name: python-airtouch2
arch: src
version: 0.8.6
epoch: 0
release: 1
summary: API for the monitoring and control of a Polyaire Airtouch 2 system over the local network
url: https://github.com/nathanvdh/airtouch2-python
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-airtouch2-0.8.6-1.src.rpm
checksum_type: sha256
description:
  In-development Python client for the Polyaire AirTouch 2 and 2+ airconditioning systems.


  https://github.com/tonymyatt/airtouch3api

  https://github.com/ozczecho/vzduch-dotek

  https://community.home-assistant.io/t/polyaire-air-touch-2-or-3/19650/44

rpm_license:
  MIT License  Copyright (c) 2022 Nathan Van der Hoek  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


pkgId: ce5a28f94751d7b38c8bf1a18980fdf1672f00a1c9e08d2ede3e61ca619d5402
name: python-airunner
arch: src
version: 3.1.6
epoch: 0
release: 1
summary: A Stable Diffusion GUI
url: https://github.com/Capsize-Games/airunner
rpm_license: GPL-3.0
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-airunner-3.1.6-1.src.rpm
checksum_type: sha256
description:
  AI Runner is an interface which allows you to run open-source large language models (LLM) and AI image generators (Stable Diffusion) on your own hardware.
  It is designed to be easy to use, with a simple and intuitive interface that allows you to run AI models without the need for a web server or cloud service.
  It has been optimized for speed and efficiency, allowing you to generate images and have conversations with chatbots in real-time.

  ![img.png](img.png)


pkgId: 8627ae50ffaa5ff028ad227dfabfdb21cd09522f7301db32f7f3c7e6f4ccf1d6
name: python-airunner-nexus
arch: src
version: 1.5.3
epoch: 0
release: 1
summary: Run a socket server for AI models.
url: https://github.com/Capsize-Games/airunner_nexus
rpm_license: GPL-3.0
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-airunner-nexus-1.5.3-1.src.rpm
checksum_type: sha256
description:
  - Offline friendly - works completely locally with no internet connection (must first download models)
  - **Sockets**: handles byte packets of an arbitrary size
  - **Threaded**: asynchronously handle requests and responses


pkgId: 588756ef2d0383f52f30ac1b46498e4922d7c60e68d5e5c43be20a4bfa2bb2ef
name: python-ais-dom
arch: src
version: 2023.11.0
epoch: 0
release: 1
summary: Open-source home automation platform running on Python 3.
url: https://www.home-assistant.io/
rpm_license: Apache-2.0
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-ais-dom-2023.11.0-1.src.rpm
checksum_type: sha256
description:
  Open source home automation that puts local control and privacy first.
  Based on  https://home-assistant.io


pkgId: 0f91f95a6caa6745b6abf1b8b8c9a7a5ce0c2ca77cd6d4958719bc5524b64032
name: python-ais-dom-frontend
arch: src
version: 20231030.1
epoch: 0
release: 1
summary: The Home Assistant frontend.
url: https://github.com/home-assistant/frontend
rpm_license: Apache-2.0
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-ais-dom-frontend-20231030.1-1.src.rpm
checksum_type: sha256
description:
  [![Netlify Status](https://api.netlify.com/api/v1/badges/78c3cc1a-7565-4d00-9f0c-45f0452d41ed/deploy-status)](https://app.netlify.com/sites/ai-speaker/deploys)



  This is the repository for the official [AI-Speaker](https://ai-speaker.com) frontend.



  AI-Speaker is open-source and Apache 2 licensed. Feel free to browse the repository, learn and reuse parts in your own projects.


pkgId: fff82a72386df56f607aa852ce53a61201c15fada432da8989c06b7d51cb2824
name: python-aisak
arch: src
version: 2.2.5
epoch: 0
release: 1
url: https://pypi.org/project/aisak/
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-aisak-2.2.5-1.src.rpm
checksum_type: sha256
summary:
  AISAK, short for Artificially Intelligent Swiss Army Knife, is a general-purpose AI system comprising various models designed for different tasks. Developed by the AISAK team, one of the models within AISAK is a state-of-the-art large multimodal model designed for text generation tasks. This package leverages usage of the model, named AISAK-O, which is fine-tuned on extensive datasets to excel in understanding and interpreting various queries in natural language text.


pkgId: 64f4975a4254d0bd08cfa433f176e589706134fc285fa953f5e1af7d0ff0491b
name: python-aisapi
arch: src
version: 0.1.1
epoch: 0
release: 1
summary: please add a summary manually as the author left a blank one
url: https://github.com/sviete/AIS-api
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-aisapi-0.1.1-1.src.rpm
checksum_type: sha256
description:
  _Python wrapper package for the AIS API._



  ```bash
  pip install aisapi
  ```

  Look at the file `example.py` for a usage example.

  [travis_status]: https://travis-ci.org/sviete/AIS-api.svg?branch=master
  [travis]: https://travis-ci.org/sviete/ais-api
  [pypi]:https://pypi.org/project/aisapi/
  [pypi_badge]: https://badge.fury.io/py/aisapi.svg




  ```bash
  git clone https://github.com/sviete/AIS-api.git

  ```




  ```bash
  rm -rf dist
  python3 setup.py sdist bdist_wheel
  twine upload dist/*
  ```


pkgId: 4e4dab385fd378b07fec5e391787ae9cba8b3f7c9b135ea9df940cd8d9917135
name: python-aisc
arch: src
version: 0.1.10
epoch: 0
release: 1
summary: AISC Helper Tools
url: https://github.com/a1sc/aisc_tools
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-aisc-0.1.10-1.src.rpm
checksum_type: sha256
description:
  ![AISC](http://aisc.io/wp-content/uploads/2018/09/logo.svg)



  [![CircleCI](https://img.shields.io/circleci/build/github/a1sc/aisc_tools.svg?label=CircleCI)](https://circleci.com/gh/a1sc/aisc_tools)
  ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/aisc.svg)
  [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black)
  ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/a1sc/aisc_tools.svg)
  [![PyPI](https://img.shields.io/pypi/v/aisc.svg)](https://pypi.org/project/aisc/)

  Small helper tools.



  `pip install aisc`



  ```python3
  from aisc import url


  url.expand(url)

  ```


pkgId: 2c9af048dc5deeacd76e62efb6d27a583cf3265c341f4a0ace6ac86db4a47b07
name: python-aisdc
arch: src
version: 1.2.0
epoch: 0
release: 1
summary: Tools for the statistical disclosure control of machine learning models
url: https://github.com/AI-SDC/AI-SDC
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-aisdc-1.2.0-1.src.rpm
checksum_type: sha256
description:
  [![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://opensource.org/licenses/MIT)
  [![Latest Version](https://img.shields.io/github/v/release/AI-SDC/AI-SDC?style=flat)](https://github.com/AI-SDC/AI-SDC/releases)
  [![DOI](https://zenodo.org/badge/518801511.svg)](https://zenodo.org/badge/latestdoi/518801511)
  [![codecov](https://codecov.io/gh/AI-SDC/AI-SDC/branch/main/graph/badge.svg?token=AXX2XCXUNU)](https://codecov.io/gh/AI-SDC/AI-SDC)
  [![Python versions](https://img.shields.io/pypi/pyversions/aisdc.svg)](https://pypi.org/project/aisdc)



  A collection of tools and resources for managing the [statistical disclosure control](https://en.wikipedia.org/wiki/Statistical_disclosure_control) of trained [machine learning](https://en.wikipedia.org/wiki/Machine_learning) models. For a brief introduction, see [Smith et al. (2022)](https://doi.org/10.48550/arXiv.2212.01233).

  The `aisdc` package provides:
  * A variety of privacy attacks for assessing machine learning models.
  * The safemodel package: a suite of open source wrappers for common machine learning frameworks, including [scikit-learn](https://scikit-learn.org) and [Keras](https://keras.io). It is designed for use by researchers in Trusted Research Environments (TREs) where disclosure control methods must be implemented. Safemodel aims to give researchers greater confidence that their models are more compliant with disclosure control.



  [![PyPI package](https://img.shields.io/pypi/v/aisdc.svg)](https://pypi.org/project/aisdc)

  Install `aisdc` and manually copy the [`examples`](examples/).

  To install only the base package, which includes the attacks used for assessing privacy:

  ```
  $ pip install aisdc
  ```

  To additionally install the safemodel package:

  ```
  $ pip install aisdc[safemodel]
  ```

  Note: macOS users may need to install libomp due to a dependency on XGBoost:
  ```
  $ brew install libomp
  ```



  See the [`examples`](examples/).



  This work was funded by UK Research and Innovation under Grant Numbers MC_PC_21033 and MC_PC_23006 as part of Phase 1 of the [DARE UK](https://dareuk.org.uk) (Data and Analytics Research Environments UK) programme, delivered in partnership with Health Data Research UK (HDR UK) and Administrative Data Research UK (ADR UK). The specific projects were Semi-Automatic checking of Research Outputs (SACRO; MC_PC_23006) and Guidelines and Resources for AI Model Access from TrusTEd Research environments (GRAIMATTER; MC_PC_21033).­This project has also been supported by MRC and EPSRC [grant number MR/S010351/1]: PICTURES.

  <img src="docs/source/images/UK_Research_and_Innovation_logo.svg" width="20%" height="20%" padding=20/> <img src="docs/source/images/health-data-research-uk-hdr-uk-logo-vector.png" width="10%" height="10%" padding=20/> <img src="docs/source/images/logo_print.png" width="15%" height="15%" padding=20/>


pkgId: 297b814e32691d2b2679db6e729578c33e9484f08d2e933d78b0c9c3f720dc83
name: python-aishell
arch: src
version: 2023.4.16.post1
epoch: 0
release: 1
summary: please add a summary manually as the author left a blank one
url: https://pypi.org/project/aishell/
rpm_license: UNKNOWN
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-aishell-2023.4.16.post1-1.src.rpm
checksum_type: sha256
description:
  [![codecov](https://codecov.io/gh/code-yeongyu/AiShell/branch/master/graph/badge.svg?token=MR72XGUQWJ)](https://codecov.io/gh/code-yeongyu/AiShell)
  [![Release Package to PyPI](https://github.com/code-yeongyu/AiShell/actions/workflows/release.yml/badge.svg)](https://github.com/code-yeongyu/AiShell/actions/workflows/release.yml)
  [![PyPI version](https://badge.fury.io/py/aishell.svg)](https://badge.fury.io/py/aishell)
  [![Downloads](https://static.pepy.tech/personalized-badge/aishell?period=month&units=international_system&left_color=grey&right_color=brightgreen&left_text=Downloads)](https://pepy.tech/project/aishell)

  A simple Python code that connects to OpenAI's ChatGPT and executes the returned results.

  If you are interested in these projects, please checkout AiShell's brother project: [YGK-a](https://github.com/code-yeongyu/YGK-a). YGK-a is a client for the ChatGPT from your terminal, and also supports unix/linux pipelines.



  ![Demo](https://raw.githubusercontent.com/code-yeongyu/AiShell/master/images/example.gif)



  - Interact with your computer using natural language
  - Automatically executes the command from the response of ChatGPT
  - Good for complex tasks like handling Git and extracting tar files
  - No need to search StackOverflow for commands, `AiShell` has got you covered
  - `AiShell` simplifies the process of setting up and retrieving tokens or API keys.
    - With `AiShell`, you don't have to worry about the technical details.
    - Simply install `AiShell`, execute it, and you're ready to go!



  - Python 3.9+
  - ChatGPT Account (or OpenAI Account)



  To begin using `AiShell`, start by installing it with pip:

  ```sh
  pip install aishell
  ```

  Once you've installed `AiShell`, you can start using it right away.
  For example, to print "Hello World" using `AiShell`, enter the following command:

  ```sh
  aishell 'print Hello World'
  ```



  By default, `AiShell` is configured to use the reverse-engineered ChatGPT client and retrieve login information from your browser, so you don't need to configure anything to use `AiShell`. However, for those who want to use different models with an OpenAI API Key, you can configure it as follows:

  1. Create an account on OpenAI.
  1. Go to <https://platform.openai.com/account/api-keys> and copy your API key.
  1. Modify or create the `~/.ygka_openai_config.json` file as follows:

    ```json
    {
        ...
        "language_model": "official_chatgpt",
        "openai_api_key": "<your OpenAI API key>"
    }
    ```

  Here, you can add your OpenAI API key. This will enable AiShell to use the official chatgpt api and the API key when executing commands.



  Feel free to contribute to `AiShell` by adding more functionality or fixing bugs.


pkgId: 5828c7fbd91c441f8990bf0c64fffe4cad2dddcb1cc1d90baa561f01c4fbd540
name: python-aishield
arch: src
version: 0.1.7
epoch: 0
release: 1
url: https://www.boschaishield.com/
rpm_license: Apache License
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-aishield-0.1.7-1.src.rpm
checksum_type: sha256
summary:
  AIShield provides the Python convenience package to allow users to seamlessly integrate AIShield Vulnerability Assessment and Defense capabilities into their AI development workflows.

description:
  ![aishield](https://aisdocs.blob.core.windows.net/images/aishieldLogoPypi.PNG)







  AIShield provides the Python convenience package to allow users to seamlessly integrate AIShield Vulnerability Assessment and Defense capabilities into their AI development workflows. Users will receive assessment reports, sample attack vectors, and a threat-informed defense model with telemetry connection to SIEM/SOAR, such as Splunk and Microsoft Sentinel.









  Requires Python>=3.6, and pip >= 19.0







      $ pip install aishield







  Check out the Quick Start Example [here](https://github.com/bosch-aisecurity-aishield/Reference-Implementations/tree/main/Product_Taskpair_wise/Image_Classification/Extraction).



  More references implementations, tutorials, samples, and documentation of AIShield can be found on our [Github Repository](https://github.com/bosch-aisecurity-aishield/Reference-Implementations).



  **Pre-requisites:**



   - AIShield API should be white-listed, or proxy settings must be appropriately configured for the AIShield API to be called.

   - Valid AIShield API subscription plan and authentication keys. For details regarding subscription please visit, [Subscription Page](https://aws.amazon.com/marketplace/pp/prodview-ppbwtiryaohti) or reach out to sales at <AIShield.Contact@bosch.com>



  **Supported Features:**



   - Model Extraction attack Vulnerability Analysis and Threat informed Defense Generation with relevant report artifacts for Image & Tabular Classification

   - Supported for Models trained on Tensorflow (Tensorflow >=2.5.0 and <=2.9.1)

   - Supported Input Model File formats: .h5,.pyc

   - Assessment Report formats available: PDF, JSON, XML, TXT



  **Supported Keywords:**



  We support various tasks and attacks, which are defined as follows:



  Attack Types

  - Extraction: `extraction`

  - Evasion: `evasion`

  - Poisoning: `poisoning`

  - Supply chain: `supply-chain`



  Task Types

  - Image Classification: `image_classification`

  - Image Segmentation: `image_segmentation`

  - Timeseries Forecasting: `timeseries_forecasting`

  - Natural Language Processing (NLP): `nlp`

  - Tabular Classification: `tabular_classification`

  - Text Recommendation: `text_recommendation`

  - Object Detection: `object_detection`



  Output Artifacts and Reports

  - Vulnerability: `vulnerability`

  - Defense: `defense`

  - Defense Model Artifact: `defense_artifact`

  - Attack Samples: `attack_samples`



  Report Formats

  - PDF: `pdf`

  - JSON: `json`









  - Website:  https://www.boschaishield.com/

  - Email:   <AIShield.Contact@bosch.com>











  - Added vulnerability analysis for supply chain attacks for all task pairs.





  - Added vulnerability analysis for Image classification task pair with data and model poisoning attack.

  - Added vulnerability analysis for Object Detection: model evasion attack

  - Added vulnerability analysis for alpha task pairs like NLP, Text Recommendation: model extraction attack.

    Defense generation for these tasks to be supported in future releases

  - ONNX model framework supports vulnerability analysis for Image Classification, Image Segmentation, Tabular Classification, and Timeseries Forecasting.





  - Added vulnerability analysis for image segmentation: model extraction attack

  - Updated to be compatible with latest AIShield API version. Also, now api_key is not required to be provided explicitly for analysis. It will be generated from org_id and policies are consumed accordingly.





  - Added vulnerability analysis for time series forecasting: model extraction attack





  - Updated to be compatible with latest AIShield API version

  - Added vulnerability analysis for tabular classification: model evasion attack





  - Added vulnerability analysis for image classification: model evasion & model poisoning attack

  - Added vulnerability analysis for tabular classification: model extraction attack





  - Updated to be compatible with latest AIShield API version





     - Initial version

     - Added vulnerability analysis for model extraction attack:

       - for image_classification task

           -  *Prepare the vulnerability configs and send the model for analysis to AIShield API.

               This will generate vulnerability analysis reports, threat-informed defense generation with SIEM/SOAR telemetry enabled, defense reports, and sample attack data artifacts.*


pkgId: 421a0a174a1328f356fc0fdcc8c83b4b03194cc6460bcb5acd5d89c136fc2595
name: python-aissemble-extensions-data-delivery-spark-py
arch: src
version: 1.10.0
epoch: 0
release: 1
summary: Contains the core Python functionality of data delivery for Spark
url: https://pypi.org/project/aissemble-extensions-data-delivery-spark-py/
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-aissemble-extensions-data-delivery-spark-py-1.10.0-1.src.rpm
checksum_type: sha256
description:
  [![PyPI](https://img.shields.io/pypi/v/aissemble-extensions-data-delivery-spark-py?logo=python&logoColor=gold)](https://pypi.org/project/aissemble-extensions-data-delivery-spark-py/)
  ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/aissemble-extensions-data-delivery-spark-py?logo=python&logoColor=gold)
  ![PyPI - Wheel](https://img.shields.io/pypi/wheel/aissemble-extensions-data-delivery-spark-py?logo=python&logoColor=gold)

  Package containing support functionality for pyspark pipelines, to be invoked largely through generated template code.

  Please see the [aiSSEMBLE Machine Learning Pipeline Patterns documentation](https://boozallen.github.io/aissemble/aissemble/current/machine-learning-pipeline-details.html)
  for more information.


pkgId: a81ed5edc0a6b342b95613e425cd30213f0442899127e5db7e6cc3d9bd02fd09
name: python-aissemble-extensions-encryption-vault-python
arch: src
version: 1.10.0
epoch: 0
release: 1
summary: Vault data encryption classes (python)
url: https://pypi.org/project/aissemble-extensions-encryption-vault-python/
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-aissemble-extensions-encryption-vault-python-1.10.0-1.src.rpm
checksum_type: sha256
description:
  [![PyPI](https://img.shields.io/pypi/v/aissemble-extensions-encryption-vault-python?logo=python&logoColor=gold)](https://pypi.org/project/aissemble-extensions-encryption-vault-python/)
  ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/aissemble-extensions-encryption-vault-python?logo=python&logoColor=gold)
  ![PyPI - Wheel](https://img.shields.io/pypi/wheel/aissemble-extensions-encryption-vault-python?logo=python&logoColor=gold)

  This module provides a package for encrypting Python based pipeline data.  There are multiple encryption algorithms
  available.  Each with their own strengths and weaknesses as outlined below.

  | Strategy                      | Description                                                                                                                                                                                                                                                                                                                                   |
  |-------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
  | VaultRemoteEncryptionStrategy | Leverages the Hashicorp Vault secrets as a service capabilities.  This is a highly recommended strategy given it follows best practices and has the advantage of a large developer base working to secure the service.                                                                                                                        |
  | VaultLocalEncryptionStrategy  | Leverages the Vault service to provide encryption keys (key rotation and secure storage) but allows for local encryption.  This is a good option if you have to encrypt large data objects.  It can also provide a performance boost over remote Vault encryption given there is no need for a roundtrip to the server for each data element. |
  | AesCbcEncryptionStrategy      | A good basic 128 bit encryption strategy.  To use this you only need to supply a single encryption key in the encrypt.properties file (128 bit or 16 character).  This algorithm works well, but is less efficient than the AES GCM algorithm.                                                                                                |
  | AesGcm96EncryptionStrategy    | This is a good strategy for most encryption needs.  It is efficient and strong against most attacks.  You can optionally use an encryption key retrieved from the Vault service with this strategy.                                                                                                                                           |


  The following example illustrates how to perform encryption.

  1. Example usage
      - Add the following to your code
      
      ```
      
      from aissemble_encrypt.vault_remote_encryption_strategy import VaultRemoteEncryptionStrategy

      vault_remote = VaultRemoteEncryptionStrategy()

      
      encrypted_value = vault_remote.encrypt('SOME PLAIN TEXT')

      
      decrypted_value = vault_remote.decrypt(encrypted_value)
      ```

      _NOTE: If you are encrypting your data through a User Defined Function (udf) in PySpark you need to use
             the VaultLocalEncryptionStrategy (see below).  Currently the remote version causes threading issues.  This issue will
             likely be resolved in a future update to the Hashicorp Vault client_
      
      ```
      
      from aissemble_encrypt.vault_local_encryption_strategy import VaultLocalEncryptionStrategy

      vault_local = VaultLocalEncryptionStrategy()

      
      encrypted_value = vault_local.encrypt('SOME PLAIN TEXT')

      
      decrypted_value = vault_local.decrypt(encrypted_value)
      ```

      
      ```
      
      from aissemble_encrypt.aes_cbc_encryption_strategy import AesCbcEncryptionStrategy

      aes_cbc = AesCbcEncryptionStrategy()

      
      encrypted_value = aes_cbc.encrypt('SOME PLAIN TEXT')

      
      decrypted_value = aes_cbc.decrypt(encrypted_value)
      ```

      
      ```
      
      from aissemble_encrypt.aes_gcm_96_encryption_strategy import AesGcm96EncryptionStrategy

      aes_gcm_96 = AesGcm96EncryptionStrategy()

      
      encrypted_value = aes_gcm_96.encrypt('SOME PLAIN TEXT')

      
      decrypted_value = aes_gcm_96.decrypt(encrypted_value)
      ```


  This package includes one security client for calling the "Secrets as a Service" encryption service.


  See the extensions-encryption [README](../../extensions-encryption/README.md#vault-encryption) for more information on how to configure Vault encryption.


pkgId: a46313feac71df2b5cb27ed83a0ef585b849fd3b1d8b258399347bad6cd9ddc7
name: python-aissemble-foundation-core-python
arch: src
version: 1.10.0
epoch: 0
release: 1
url: https://pypi.org/project/aissemble-foundation-core-python/
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-aissemble-foundation-core-python-1.10.0-1.src.rpm
checksum_type: sha256
summary:
  Core classes for supporting concepts (alerting, metadata, etc) that are needed across most Python-based components

description:
  [![PyPI](https://img.shields.io/pypi/v/aissemble-foundation-core-python?logo=python&logoColor=gold)](https://pypi.org/project/aissemble-foundation-core-python/)
  ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/aissemble-foundation-core-python?logo=python&logoColor=gold)
  ![PyPI - Wheel](https://img.shields.io/pypi/wheel/aissemble-foundation-core-python?logo=python&logoColor=gold)

  This package includes authorization and authentication for Python based applications as well as code for metadata


pkgId: 3c3631ba99eab1a063c9c7e51d9797f1cded9e77fd3b9753557f3d6d79ffb4a7
name: python-aissemble-foundation-drift-detection-client-python
arch: src
version: 1.10.0
epoch: 0
release: 1
summary: please add a summary manually as the author left a blank one
url: https://pypi.org/project/aissemble-foundation-drift-detection-client-python/
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-aissemble-foundation-drift-detection-client-python-1.10.0-1.src.rpm
checksum_type: sha256
description:
  [![PyPI](https://img.shields.io/pypi/v/aissemble-foundation-drift-detection-client-python?logo=python&logoColor=gold)](https://pypi.org/project/aissemble-foundation-drift-detection-client-python/)
  ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/aissemble-foundation-drift-detection-client-python?logo=python&logoColor=gold)
  ![PyPI - Wheel](https://img.shields.io/pypi/wheel/aissemble-foundation-drift-detection-client-python?logo=python&logoColor=gold)

  TODO: document functionality


pkgId: 591d6e439c40b060c145997a11ceb82e0d8af028312a4c26a9b81812593d6cb9
name: python-aissemble-foundation-messaging-python
arch: src
version: 1.10.0
epoch: 0
release: 1
summary: Defines a root level messaging architecture in python
url: https://pypi.org/project/aissemble-foundation-messaging-python/
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-aissemble-foundation-messaging-python-1.10.0-1.src.rpm
checksum_type: sha256
description:
  [![PyPI](https://img.shields.io/pypi/v/aissemble-foundation-messaging-python?logo=python&logoColor=gold)](https://pypi.org/project/aissemble-foundation-messaging-python/)
  ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/aissemble-foundation-messaging-python?logo=python&logoColor=gold)
  ![PyPI - Wheel](https://img.shields.io/pypi/wheel/aissemble-foundation-messaging-python?logo=python&logoColor=gold)


  aiSSEMBLE&trade;'s python messaging module provides an interface through which python pipelines can leverage messaging's
  features. This is done through the MessagingClient class, the details of which are discussed below, along with
  examples of its use.


  The messaging client can pass along a subscription request to the service to subscribe to a given topic. The message client can start receiving messages after subscription. However, any messages before subscription will be ignored. To do this, you will need to tell the service which topic you want to subscribe to, provide a callback function if you would like to execute one, and an acknowledgement strategy for handling messages on the topic.

  ```python
  def my_pipeline_function()
  client = MessagingClient()
  ack_strategy = AckStrategy.<STRATEGY>
  client.subscribe("topic_name", my_callback_func(), ack_strategy)
  ```


  The messaging client can send a message to a given topic name through the service and will receive back a future object to handle that messages receipt. To do this, you can simply provide a topic name and a message object containing the text string for your message, like the following example.

  ```python
  c = MessagingClient()
  message = Message()
  message.set_payload("test message")
  result = c.queueForSend("TopicA", message)
  ```


  The message client can receive a message to a given topic name through the service after subscribe to the topic. However, any messages to the given topic before subscription is made will be ignored.

  To do this, you can define a Callback function and subscribe to the topic with the Callback function created, like the following example:

  Note: the client can must ack or nack the message received. If there are any exception thrown during the process time, the exception will be handled by the service and the message will be nacked.
  ```python
  from aissemble_messaging import ProcessMessageError, MessagingClient, AckStrategy, Message, Callback
  import threading

  def receive_message(msg: Message, topic):
      message_received = msg.get_payload()
      print("Received message from topic: {}, message: {}".format(topic, message_received))

      
      
      if "nacked" in message_received :
          return msg.nack("receiver nacks the message: " + message_received)

      
      
      if "problem" in message_received:
          raise Exception("error while processing message: " + message_received)

      
      return msg.ack()

  def demo_topic_callback(msg: Message):
      receive_message(msg, "demoTopic")

  def subscribe_to_topic(consumer, callback_func):
      consumer.subscribe("demoTopic", callback_func, AckStrategy.MANUAL)
      is_subscribed = consumer.isTopicSubscribed("demoTopic")
      while is_subscribed:
          pass



  client = MessagingClient(properties_location = os.path.join("microprofile-config.properties"))

  sb_thread = threading.Thread(target=subscribe_to_topic,args=[client, Callback(demo_topic_callback)])
  sb_thread.start()
  ```


  The testing strategy for the client's integration tests is to run the messaging service's jar through py4j's launch_gateway() function, and then interact with it through the MessagingClient class. In addition to running the jar, the launch_gateway() function has some quality of life features for testing. In order to include logging from the jvm in the python test output, add the following parameters to the function, and run the behave tests with the --no-capture flag.

  ```python
  redirect_stdout=sys.stdout,
  redirect_stderr=sys.stdout
  ```

  Please see the [aiSSEMBLE Messaging documentation](https://boozallen.github.io/aissemble/aissemble/current/messaging-details.html)
  for additional general information.


pkgId: fd9b0d33a63aae7f6e8e5076611b74ae313465bd507d20660885ac572111785b
name: python-aissemble-foundation-pdp-client-python
arch: src
version: 1.10.0
epoch: 0
release: 1
summary: REST Policy Decision Point (PDP) client for Python-based components
url: https://pypi.org/project/aissemble-foundation-pdp-client-python/
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-aissemble-foundation-pdp-client-python-1.10.0-1.src.rpm
checksum_type: sha256
description:
  [![PyPI](https://img.shields.io/pypi/v/aissemble-foundation-pdp-client-python?logo=python&logoColor=gold)](https://pypi.org/project/aissemble-foundation-pdp-client-python/)
  ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/aissemble-foundation-pdp-client-python?logo=python&logoColor=gold)
  ![PyPI - Wheel](https://img.shields.io/pypi/wheel/aissemble-foundation-pdp-client-python?logo=python&logoColor=gold)

  This module provides a client for authorizing a jwt, action and resource

  The following tasks will help you add authentication to your module.

  1. Example usage
      - Add the following to your code
      -
      ```python
          
          
          pdp_client = PDPClient(auth_config.pdp_host_url())
          decision = pdp_client.authorize(your_jwt_string, None, 'some-action')
          if 'PERMIT' == decision:
              print('User is authorized to access XYZ')
          else:
              raise AissembleSecurityException('User is not authorized')
      ```


pkgId: ab41a860d5e6a854fa7625423842fe0f1772bd9fbff582620a7e9fe0dfa46d66
name: python-aistore
arch: src
version: 1.10.0
epoch: 0
release: 1
url: https://aiatscale.org
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-aistore-1.10.0-1.src.rpm
checksum_type: sha256
summary:
  A (growing) set of client-side APIs to access and utilize clusters, buckets, and objects on AIStore.

description:
  This package contains the AIStore Python SDK, PyTorch integration, and Botocore patch.
  See the README files in each module for usage details:

  - [SDK](https://github.com/NVIDIA/aistore/blob/main/python/aistore/sdk/README.md)
  - [PyTorch](https://github.com/NVIDIA/aistore/blob/main/python/aistore/pytorch/README.md)
  - [Botocore](https://github.com/NVIDIA/aistore/blob/main/python/aistore/botocore_patch/README.md)



  * [AIStore GitHub](https://github.com/NVIDIA/aistore)
  * [Documentation](https://aistore.nvidia.com/docs)
  * [AIStore pip package](https://pypi.org/project/aistore/)
  * [Videos and demos](https://github.com/NVIDIA/aistore/blob/main/docs/videos.md)


pkgId: d071be0004a9a7c0a8308cbe732f1e5cd163edaba10186277ea080cc295a2dfa
name: python-aistrainer
arch: src
version: 0.0.13
epoch: 0
release: 1
summary: AI Specialization Trainer for LLM models
url: https://github.com/Equiron-AI/aistrainer
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-aistrainer-0.0.13-1.src.rpm
checksum_type: sha256
description:
  **Aistrainer** is a library built on top of **Hugging Face Transformers**, designed to simplify the process of fine-tuning large language models (LLMs) for developers. It focuses on making LLM fine-tuning feasible even with limited computational resources, such as Nvidia GeForce RTX 3090 GPUs. The library supports training on both GPUs and CPUs, and it includes a feature for offloading model weights to the CPU when using a single GPU. With one **Nvidia GeForce RTX 3090 GPU** and **256 GB of RAM**, Aistrainer can handle fine-tuning models with up to approximately **70 billion** parameters.


  The Aistrainer library is compatible with the Ubuntu 22.04 operating system. To set up the required environment for this library, system tools must be installed using the command:
  ```console
  sudo apt install -y python3-pip ccache make cmake g++ mpich
  ```
  To create a Python virtual environment with a GPU, use the command:
  ```console
  conda env create -f environment.yml
  ```
  In the absence of a GPU, the environment can be set up with the command:
  ```console
  conda env create -f environment-cpu.yml
  ```
  These steps ensure that all necessary dependencies are correctly configured, allowing the Aistrainer library to function optimally.


  ```console
  pip install aistrainer
  ```


  The following commands allow you to update operating system drivers:
  ```console
  sudo rm -r /var/lib/dkms/nvidia
  sudo dpkg -P --force-all $(dpkg -l | grep "nvidia-" | grep -v lib | awk '{print $2}')
  sudo ubuntu-drivers install
  ```


  If you use JupyterLab then you need to add a new kernel with a conda environment:
  ```console
  conda activate aist
  conda install ipykernel
  ipython kernel install --user --name=aist
  ```


  When fine-tuning models with a large number of parameters, it might be necessary to increase the operating system's swap space. This can be done using the following steps:

  ```console
  sudo swapoff -a
  sudo fallocate -l 50G
  sudo chmod 600
  sudo mkswap /swapfile
  sudo swapon /swapfile
  ```

  These commands will increase the swap space, providing additional virtual memory that can help manage the large memory requirements during model fine-tuning.

  Swap should be used only in case of extreme necessity, as it can significantly slow down the training process. To ensure that the system uses swap space minimally, you should add the following line to the **/etc/sysctl.conf file**: **vm.swappiness=1**. This setting minimizes the swappiness, making the system less likely to swap processes out of physical memory and thus relying more on RAM, which is much faster than swap space.


  - If a GPU is available, the Aistrainer library automatically leverages DeepSpeed to offload model weights to RAM. This optimization allows for efficient management of memory resources, enabling the fine-tuning of larger models even with limited GPU memory.
  - The Aistrainer library supports only a specific dataset format, which must include the following columns: "instruct", "input", and "output". These columns are essential for the proper functioning of the library, as they structure the data in a way that the model can interpret and learn from effectively.
  - If the eval=True parameter is passed to the prepare_dataset method, the Aistrainer library will automatically use 10% of the data in the dataset as validation data, creating an evaluation dataset. This feature allows for easy splitting of the dataset, ensuring that a portion of the data is reserved for evaluating the model's performance during training, thereby facilitating better model assessment and tuning.
  - The Aistrainer library fundamentally avoids using quantization during the fine-tuning process to prevent any potential loss of quality. This approach ensures that the experiments remain straightforward and maintain the highest possible model accuracy.
  - For combining LoRA adapters, the Aistrainer library supports only the "cat" method. In this method, the LoRA matrices are concatenated, providing a straightforward and effective approach for merging adapters.


  The following LLM models are supported:
  - Phi-3-medium-128k-instruct
  - c4ai-command-r-v01


  ```python
  import logging
  from aistrainer.aistrainer import Aist

  logging.basicConfig(level=logging.INFO)

  aist = Aist("CohereForAI/c4ai-command-r-v01")

  aist.prepare_dataset("equiron-ai/safety",
                       eval=False,  # use the entire dataset only for training
                       max_len_percentile=100)  # percentile cutting off the longest lines

  aist.train("safety_adapter",
             rank=16,
             lora_alpha=32,
             batch_size=4,  # suitable for most cases, but should be reduced if there is not enough GPU memory
             gradient_steps=2)  # suitable for most cases, but should be reduced if there is not enough GPU memory
  ```


  ```python
  import logging
  from aistrainer.aistrainer import Aist

  logging.basicConfig(level=logging.INFO)

  aist = Aist("CohereForAI/c4ai-command-r-v01")
  aist.merge("model_with_safety", "safety_adapter")
  ```


  Model fine-tuning and combining adapters cannot be performed in the same bash script or Jupyter session. It is essential to separate the processes of fine-tuning and adapter merging. When using JupyterLab, you must restart the kernel after completing each of these processes to ensure proper execution and avoid conflicts.


  ```console
  python3 llama.cpp/convert-hf-to-gguf.py /path/to/model --outfile model.gguf --outtype f16
  llama.cpp/build/bin/quantize model.gguf model_q5_k_m.gguf q5_k_m
  ```


  ```console
  llama.cpp/build/bin/server -m model_q5_k_m.gguf -ngl 99 -fa -c 4096 --host 0.0.0.0 --port 8000
  ```


  Please note that the toolkit version must match the driver version. The driver version can be found using the nvidia-smi command.
  Аor example, to install toolkit for CUDA 12.2 you need to run the following commands:
  ```console
  CUDA_TOOLKIT_VERSION=12-2
  wget https://developer.download.nvidia.com/compute/cuda/repos/ubuntu2204/x86_64/cuda-keyring_1.1-1_all.deb
  sudo dpkg -i cuda-keyring_1.1-1_all.deb
  sudo apt update
  sudo apt -y install cuda-toolkit-${CUDA_TOOLKIT_VERSION}
  echo -e '
  export CUDA_HOME=/usr/local/cuda
  export PATH=${CUDA_HOME}/bin:${PATH}
  export LD_LIBRARY_PATH=${CUDA_HOME}/lib64:$LD_LIBRARY_PATH
  ' >> ~/.bashrc
  ```


pkgId: 897e05944dc282c716db8c26e46a80c36ce9d7963b96639510ad2827aed32a1c
name: python-aisuite
arch: src
version: 0.1.6
epoch: 0
release: 1
summary: Uniform access layer for LLMs
url: https://pypi.org/project/aisuite/
rpm_license: None
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-aisuite-0.1.6-1.src.rpm
checksum_type: sha256
description:
  [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

  Simple, unified interface to multiple Generative AI providers.

  `aisuite` makes it easy for developers to use multiple LLM through a standardized interface. Using an interface similar to OpenAI's, `aisuite` makes it easy to interact with the most popular LLMs and compare the results. It is a thin wrapper around python client libraries, and allows creators to seamlessly swap out and test responses from different LLM providers without changing their code. Today, the library is primarily focussed on chat completions. We will expand it cover more use cases in near future.

  Currently supported providers are -
  OpenAI, Anthropic, Azure, Google, AWS, Groq, Mistral, HuggingFace and Ollama.
  To maximize stability, `aisuite` uses either the HTTP endpoint or the SDK for making calls to the provider.



  You can install just the base `aisuite` package, or install a provider's package along with `aisuite`.

  This installs just the base package without installing any provider's SDK.

  ```shell
  pip install aisuite
  ```

  This installs aisuite along with anthropic's library.
  ```shell
  pip install aisuite[anthropic]
  ```

  This installs all the provider-specific libraries
  ```shell
  pip install aisuite[all]
  ```



  To get started, you will need API Keys for the providers you intend to use. You'll need to
  install the provider-specific library either separately or when installing aisuite.

  The API Keys can be set as environment variables, or can be passed as config to the aisuite Client constructor.
  You can use tools like [`python-dotenv`](https://pypi.org/project/python-dotenv/) or [`direnv`](https://direnv.net/) to set the environment variables manually. Please take a look at the `examples` folder to see usage.

  Here is a short example of using `aisuite` to generate chat completion responses from gpt-4o and claude-3-5-sonnet.

  Set the API keys.
  ```shell
  export OPENAI_API_KEY="your-openai-api-key"
  export ANTHROPIC_API_KEY="your-anthropic-api-key"
  ```

  Use the python client.
  ```python
  import aisuite as ai
  client = ai.Client()

  models = ["openai:gpt-4o", "anthropic:claude-3-5-sonnet-20240620"]

  messages = [
      {"role": "system", "content": "Respond in Pirate English."},
      {"role": "user", "content": "Tell me a joke."},
  ]

  for model in models:
      response = client.chat.completions.create(
          model=model,
          messages=messages,
          temperature=0.75
      )
      print(response.choices[0].message.content)

  ```
  Note that the model name in the create() call uses the format - `<provider>:<model-name>`.
  `aisuite` will call the appropriate provider with the right parameters based on the provider value.
  For a list of provider values, you can look at the directory - `aisuite/providers/`. The list of supported providers are of the format - `<provider>_provider.py` in that directory. We welcome  providers adding support to this library by adding an implementation file in this directory. Please see section below for how to contribute.

  For more examples, check out the `examples` directory where you will find several notebooks that you can run to experiment with the interface.



  aisuite is released under the MIT License. You are free to use, modify, and distribute the code for both commercial and non-commercial purposes.



  If you would like to contribute, please read our [Contributing Guide](CONTRIBUTING.md) and join our [Discord](https://discord.gg/T6Nvn8ExSb) server!


  We have made easy for a provider or volunteer to add support for a new platform.



  We follow a convention-based approach for loading providers, which relies on strict naming conventions for both the module name and the class name. The format is based on the model identifier in the form `provider:model`.

  - The provider's module file must be named in the format `<provider>_provider.py`.
  - The class inside this module must follow the format: the provider name with the first letter capitalized, followed by the suffix `Provider`.



  - **Hugging Face**:
    The provider class should be defined as:
    ```python
    class HuggingfaceProvider(BaseProvider)
    ```
    in providers/huggingface_provider.py.

  - **OpenAI**:
    The provider class should be defined as:
    ```python
    class OpenaiProvider(BaseProvider)
    ```
    in providers/openai_provider.py

  This convention simplifies the addition of new providers and ensures consistency across provider implementations.


pkgId: dbd61211a35c66ac6bcc88c2188acc8146d2e540a0094790c7ece9a3c83b3b9a
name: python-ait-bsc
arch: src
version: 7.5.5
epoch: 0
release: 1
summary: AIT - Accelerator Integration Tool
url: https://pm.bsc.es/ompss-at-fpga
rpm_license: GNU Lesser General Public License v3 (LGPLv3)
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-ait-bsc-7.5.5-1.src.rpm
checksum_type: sha256
description:
  [![PyPI version](https://img.shields.io/pypi/v/ait-bsc.svg?logo=pypi&logoColor=FFE873)](https://pypi.org/project/ait-bsc/)
  [![Licence](https://img.shields.io/github/license/bsc-pm-ompss-at-fpga/ait.svg)](LICENSE)
  [![PyPi Downloads](https://img.shields.io/pypi/dm/ait-bsc?label=PyPI%20Downloads)](https://pypistats.org/packages/ait-bsc)
  [![Total Downloads](https://static.pepy.tech/personalized-badge/ait-bsc?period=total&units=international_system&left_color=black&right_color=red&left_text=Total+Downloads)](https://pepy.tech/project/ait-bsc)
  [![Supported Python versions](https://img.shields.io/pypi/pyversions/ait-bsc.svg?logo=python&logoColor=FFE873)](https://pypi.org/project/ait-bsc/)



  The Accelerator Integration Tool (AIT) automatically integrates OmpSs@FPGA and OmpSs-2@FPGA accelerators into FPGA designs using different vendor backends.

  This README should help you install the AIT component of the OmpSs@FPGA toolchain from the repository.
  However, it is preferred using the pre-built Docker image with the latest stable toolchain.
  They are available at [OmpSs@FPGA pre-built Docker images](https://ompssatfpga.bsc.es/downloads/ompss/docker/) and [OmpSs-2@FPGA pre-built Docker images](https://ompssatfpga.bsc.es/downloads/ompss-2/docker/).

  Moreover, there are pre-built SD images for the current supported board families: Zynq7000 and Ultrascale.
  They are also available at [OmpSs@FPGA pre-built SD images](https://ompssatfpga.bsc.es/downloads/ompss/sd-images/) and [OmpSs-2@FPGA pre-built SD images](https://ompssatfpga.bsc.es/downloads/ompss-2/sd-images/).


   - [Python 3.7 or later](https://www.python.org)
   - [pip](https://pip.pypa.io)
   - Vendor backends:
     - [Xilinx Vivado 2021.1 or later](https://www.xilinx.com/support/download/index.html/content/xilinx/en/downloadNav/vivado-design-tools/archive.html)



  This repository uses Git Large File Storage to handle relatively-large files that are frequently updated (i.e. hardware runtime IP files) to avoid increasing the history size unnecessarily. You must install it so Git is able to download these files.

  Follow instructions on their website to install it.





  Follow installation instructions for Xilinx Vivado, Vitis HLS and SDK, as well as enable support during setupt for the devices you plan to use.
  However, components can be added or removed afterwards.

  Current version supports Vivado 2021.1 onwards.





  You can use `pip` to easily install `ait` on your system:

      python3 -m pip install ait-bsc



  1. Make sure you have the following packages installed on your system

      * `git-lfs` ([Git Large File Storage](https://git-lfs.github.com))
      * `setuptools >= 61.0` ([setuptools](https://setuptools.pypa.io/en/latest/userguide/quickstart.html#installation))

  2. Clone AIT's repository

      * From GitHub:

            git clone https://github.com/bsc-pm-ompss-at-fpga/ait.git

      * From our internal GitLab repository (BSC users only):

            git clone https://pm.bsc.es/gitlab/ompss-at-fpga/ait.git

  3. Enable Git LFS and install

         cd ait
         git lfs install
         git lfs pull
         export AIT_HOME="/path/to/install/ait"
         export DEB_PYTHON_INSTALL_LAYOUT=deb_system
         python3 -m pip install . -t $AIT_HOME

  4. Add the installed binaries to your PATH

         export PATH=$AIT_HOME/bin:$PATH
         export PYTHONPATH=$AIT_HOME:$PYTHONPATH



  1. Make sure you have the following packages installed on your system

      * `wheel` ([wheel](https://wheel.readthedocs.io/en/stable/installing.html))
      * `setuptools >= 61.0` ([setuptools](https://setuptools.pypa.io/en/latest/userguide/quickstart.html#installation))

  2. Copy AIT sources into target machine

  3. Build wheel for AIT and install

         cd ait
         python3 setup.py bdist_wheel
         export AIT_HOME="/path/to/install/ait"
         export DEB_PYTHON_INSTALL_LAYOUT=deb_system
         python3 -m pip install dist/ait_bsc-*.whl --no-index -t $AIT_HOME

  4. Add the installed binaries to your PATH

         export PATH=$AIT_HOME/bin:$PATH
         export PYTHONPATH=$AIT_HOME:$PYTHONPATH





   * python3-flake8
   * python3-unittest



  The python code follows PEP 8 style guide which is verified using the `flake8` tool.

  To check the current source code just execute `python3 -m flake8`.



  The `test` folder contains some unitary tests for python sources.

  To run all tests the command `python3 -m unittest` can be executed in the root directory of the repository.


pkgId: 23a9b43186486f322f4a912c84ae289301b2bb2a92c169397331bf3f42f6aca4
name: python-ait-cli
arch: src
version: 1.0.0
epoch: 0
release: 1
summary: Command Line Tools for AIT
url: https://pypi.org/project/ait-cli/
rpm_license: Apache License Version 2.0
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-ait-cli-1.0.0-1.src.rpm
checksum_type: sha256
description:
  **AIT-CLI** は、AIT開発に関連するコマンドラインツールです。このツールを使用すると、以下の操作をコマンドラインから簡単に実行できます。

  - AITテンプレートの作成
  - AIT開発環境のJupyter Labの起動
  - サードパーティの通知生成
  - AITパッケージの圧縮
  - AITのGitHubへのプッシュ

  これにより、AITのセットアップや操作を効率的に行うことができます。



  - AIT開発者



  以下のコマンドでインストールできます。

  ```bash
  pip install ait-cli
  ```

  > [!IMPORTANT]
  > ローカル環境（システム全体）にインストールした場合、`ait-cli`コマンドは**システム全体**で利用可能です。仮想環境にインストールした場合、`ait-cli`コマンドは**インストールした仮想環境でのみ**利用可能です。

  > [!TIP]
  > #### Windows
  > Windowsにインストールする際、権限の問題でインストール時にait-cliの実行ファイルが作成されない場合があります。その場合は、`pip install ait-cli`を**管理者権限**で立ち上げたコマンドプロンプトで実行してください。
  > #### Mac, Linux
  > MacまたはLinuxにインストールする際、ait-cliのパスが通らない場合があります。`bashrc`もしくは`zshrc`を修正して、ait-cliの実行ファイル（binファイル）のパスを通してください。 通常、実行ファイルは`~/.local/bin`に作成されます。
  > bashの例
  > ```bash
  > echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
  > source ~/.bashrc
  > ```



  AIT-CLIは「gitコマンドの使用」「gitのuser.emailとuser.nameの設定」「GitHubへのSSH接続」「dockerコマンドの使用」を前提としております。
  以下コマンドの実行結果がそれぞれ問題ないことを確認してください。

  - **gitコマンド**

  ```bash
  git --version

  ```

  - **user.emailとuser.nameの設定**
  ```bash
  git config --global user.email


  git config --global user.name

  ```

  - **GitHubへのSSH接続**

  ```bash
  ssh -T git@github.com

  ```

  - **dockerコマンド**

  ```bash
  docker --version

  ```

  インストールや設定方法についてはリンク先でご確認ください。
  - **git**: https://git-scm.com/
  - **GitHubへのSSH接続**: https://docs.github.com/ja/authentication/connecting-to-github-with-ssh
  - **docker**: https://www.docker.com/ja-jp/

  > [!CAUTION]
  > 本ガイド執筆時点で、Docker Desktopの無償利用には条件があり、必ずしも利用者の手元において問題なく利用できるとは限りません。ご自身で使用許諾条件を確認いただく必要があります。






  `ait-cli`は、複数のサブコマンドを提供しています。以下のコマンドでヘルプを確認できます。

  ```bash
  ait-cli --help
  ```



  以下のサブコマンドを利用できます。

  | コマンド              | 説明                                    | オプション                                                                 |
  |-----------------------|----------------------------------------|--------------------------------------------------------------------------|
  | `create`              | AITテンプレートをセットアップする       | `--ait_name`: 開発するAITの名前（必須）<br> `--path`: AITの配置先のパス |
  | `jupyter`             | AITをJupyter Labで起動する      | `--path`: Jupyter Labを起動するAITのパス               |
  | `thirdparty-notice`   | AITのサードパーティライセンス通知を生成 | `--path`: サードパーティ通知を生成するAITのパス             |
  | `zip`                 | AITをzipに圧縮する                   | `--path`: 圧縮するAITのパス                                   |
  | `git-push`            | AITを指定したGitHubのリポジトリにプッシュする            | `--github_repository`: GitHubリポジトリURL（初回のプッシュ時に必須）<br> `--path`: プッシュするAITのパス |



  指定したディレクトリに、`--ait_name`で指定した名前のAITテンプレートをセットアップします。

  ```bash
  ait-cli create --ait_name <YourAITName> --path <directory path>
  ```



  - `--ait_name`: 開発するAITの名前（必須）
  - `--path`: AITの配置先のパス。デフォルトは現在のディレクトリ

  > ### AITの命名規則
  > AITの命名時に推奨される命名規則は以下の通りです。
  > * `{prefix}_{target}_{format}_{task}_{measure}`
  >
  > | 項目名               | 必須 | 説明                                                           |
  > |----------------------|------|----------------------------------------------------------------|
  > | prefix               | ○   | AITのタイプを表します。<br>- eval : 品質評価<br>- alyz : 分析<br>- misc : その他<br>- generate : AITに入力するデータを生成するAITに使います。 |
  > | target               | ○   | AITの評価対象によって"dataset"か"model"のいずれかを選択します。|
  > | task                 | ×   | AITが対象とする問題<br>例.image_classifier                              |
  > | format               | ×   | AITが取り扱うデータの形式<br>例. table                                      |
  > | measure              | ×   | AITで取り扱う品質特性<br>例. coverage_of_dataset                                          |
  >
  > * 制限
  >   * 名称は50文字以下にする必要があります
  >   * 利用可能な文字は、半角英数字 と `_` です



  AITをJupyter Labで起動します。

  ```bash
  ait-cli jupyter --path <directory path>
  ```



  - `--path`: Jupyter Labを起動するAITのパス。デフォルトは現在のディレクトリ

  > [!TIP]
  > dockerが起動していない場合、Jupyter Labは起動しません。



  AITのサードパーティ通知を生成します。

  ```bash
  ait-cli thirdparty-notice --path <directory path>
  ```



  - `--path`: サードパーティ通知を生成するAITのパス。デフォルトは現在のディレクトリ

  > [!CAUTION]
  > `thirdparty-notic`コマンドはOSSライセンスの完全なリストアップを保証しません。必ずご自身で内容を確認してください



  AITをzip圧縮します。

  ```bash
  ait-cli zip --path <directory path>
  ```



  - `--path`: 圧縮するAITのパス。デフォルトは現在のディレクトリ

  > [!TIP]
  > zipパッケージがインストールされていない場合、このコマンドは失敗します。特にLinux環境で頻発する問題です。`sudo apt-get install zip`を実行したのちに、再度`ait-cli zip`の実行をお願いします。



  AITを指定したGitHubのリポジトリにプッシュします。

  ```bash
  ait-cli git-push --github_repository <Your GitHub repository URL> --path <directory path>
  ```



  - `--github_repository`: 最初のプッシュ時にGitHubリポジトリのURLを指定してください。2回目以降は省略可能です。2回目以降のプッシュ時にURLを**上書き**する場合にはこのオプションを指定してください。
  - `--path`: プッシュするAITのパス。デフォルトは現在のディレクトリ

  > [!CAUTION]
  > GITHUBへ登録すると、開発したAITは一般公開されます。AITの公開に際しては、個人情報や機密情報を公開していないか、また公開が目的に即しているか、十分確認した上で実施してください。



  実際のAIT開発フローに沿った使用例を紹介します。

  1. AIT-CLIをインストール

  ```bash
  pip install ait-cli
  ```

  2. AITテンプレートをセットアップ

  ```bash
  ait-cli create --ait_name AIT_sample
  ```

  3. ディレクトリを移動し、Jupyter Labを立ち上げる

  ```bash
  cd AIT_sample
  ait-cli jupyter
  ```

  4. Jupyter Lab内でAITの開発とユニットテスト

  5. サードパーティ通知の生成

  ```bash
  ait-cli thirdparty-notice
  ```

  6. Qunomonとの結合テスト用にAITをzipに圧縮

  ```bash
  ait-cli zip
  ```

  7. 結合テストを実施

  8. 開発したAITをGitHubに登録

  ```bash
  ait-cli git-push --github_repository git@github.com:~
  ```

  **AIT開発の詳細なガイドについてはこちらをご確認ください**
  https://aistairc.github.io/qunomon/ait-guide/index.html





  ```bash
  Error: Failed to clone the repository. Please check your network connection or the repository URL.
  Details: Command execution failed with error code: <エラーコード>
  ...
  ```

  **解決策**: gitがインストールされているか、GitHubとSSH接続が確立できているか、PCがオンラインであるか、を確認してください。



  ```bash
  Error: Script '<script_name>' not found. Please verify the path.
  ```

  **解決策**: `ait-cli`コマンドがAITのルートディレクトリで実行されているか、`--path`オプションが正しいか、を確認してください。



  ```bash
  Error: Directory '<directory_name>' not found. Please verify the path.
  ```

  **解決策**: `ait-cli`コマンドがAITのルートディレクトリで実行されているか、`--path`オプションが正しいか、を確認してください。


  AIST AIRC



  Apache License Version 2.0


pkgId: b01db940771619257fa5e4bdb381e5ff03e870c9883fa9f32f2629a5e94e41e0
name: python-aitextgen
arch: src
version: 0.6.0
epoch: 0
release: 1
summary: A robust Python tool for text-based AI training and generation using GPT-2.
url: https://github.com/minimaxir/aitextgen
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-aitextgen-0.6.0-1.src.rpm
checksum_type: sha256
description:
  A robust Python tool for text-based AI training and generation using [OpenAI's](https://openai.com) [GPT-2](https://openai.com/blog/better-language-models/) and [EleutherAI's](https://www.eleuther.ai) [GPT Neo/GPT-3](https://github.com/EleutherAI/gpt-neo) architecture.

  aitextgen is a Python package that leverages [PyTorch](https://pytorch.org), [Hugging Face Transformers](https://github.com/huggingface/transformers) and [pytorch-lightning](https://github.com/PyTorchLightning/pytorch-lightning) with specific optimizations for text generation using GPT-2, plus _many_ added features. It is the successor to [textgenrnn](https://github.com/minimaxir/textgenrnn) and [gpt-2-simple](https://github.com/minimaxir/gpt-2-simple), taking the best of both packages:

  - Finetunes on a pretrained 124M/355M/774M GPT-2 model from OpenAI or a 125M/350M GPT Neo model from EleutherAI...or create your own GPT-2/GPT Neo model + tokenizer and train from scratch!
  - Generates text faster than gpt-2-simple and with better memory efficiency!
  - With Transformers, aitextgen preserves compatibility with the base package, allowing you to use the model for other NLP tasks, download custom GPT-2 models from the HuggingFace model repository, and upload your own models! Also, it uses the included `generate()` function to allow a massive amount of control over the generated text.
  - With pytorch-lightning, aitextgen trains models not just on CPUs and GPUs, but also _multiple_ GPUs and (eventually) TPUs! It also includes a pretty training progress bar, with the ability to add optional loggers.
  - The input dataset is its own object, allowing you to not only easily encode megabytes of data in seconds, cache, and compress it on a local computer before transporting to a remote server, but you are able to _merge_ datasets without biasing the resulting dataset, or _cross-train_ on multiple datasets to create blended output.

  You can read more about aitextgen [in the documentation](https://docs.aitextgen.io/)!



  You can play with aitextgen _for free_ with powerful GPUs using these Colaboratory Notebooks!

  - [Finetune OpenAI's 124M GPT-2 model (or GPT Neo) on your own dataset (GPU)](https://colab.research.google.com/drive/15qBZx5y9rdaQSyWpsreMDnTiZ5IlN0zD?usp=sharing)
  - [Train a GPT-2 model + tokenizer from scratch (GPU)](https://colab.research.google.com/drive/144MdX5aLqrQ3-YW-po81CQMrD6kpgpYh?usp=sharing)

  You can also play with custom [Reddit](notebooks/reddit_demo.ipynb) and [Hacker News](notebooks/hacker_news_demo.ipynb) demo models on your own PC.



  aitextgen can be installed [from PyPI](https://pypi.org/project/aitextgen/):

  ```sh
  pip3 install aitextgen
  ```



  Here's how you can quickly test out aitextgen on your own computer, even if you don't have a GPU!

  For generating text from a pretrained GPT-2 model:

  ```py3
  from aitextgen import aitextgen


  ai = aitextgen()

  ai.generate()
  ai.generate(n=3, max_length=100)
  ai.generate(n=3, prompt="I believe in unicorns because", max_length=100)
  ai.generate_to_file(n=10, prompt="I believe in unicorns because", max_length=100, temperature=1.2)
  ```

  You can also generate from the command line:

  ```sh
  aitextgen generate
  aitextgen generate --prompt "I believe in unicorns because" --to_file False
  ```

  Want to train your own mini GPT-2 model on your own computer? You can follow along [in this Jupyter Notebook](/notebooks/training_hello_world.ipynb) or, download this [text file of Shakespeare's plays](https://raw.githubusercontent.com/karpathy/char-rnn/master/data/tinyshakespeare/input.txt), cd to that directory in a Terminal, open up a `python3` console and go:

  ```py3
  from aitextgen.TokenDataset import TokenDataset
  from aitextgen.tokenizers import train_tokenizer
  from aitextgen.utils import GPT2ConfigCPU
  from aitextgen import aitextgen


  file_name = "input.txt"




  train_tokenizer(file_name)
  tokenizer_file = "aitextgen.tokenizer.json"



  config = GPT2ConfigCPU()


  ai = aitextgen(tokenizer_file=tokenizer_file, config=config)



  data = TokenDataset(file_name, tokenizer_file=tokenizer_file, block_size=64)



  ai.train(data, batch_size=8, num_steps=50000, generate_every=5000, save_every=5000)


  ai.generate(10, prompt="ROMEO:")



  ai2 = aitextgen(model_folder="trained_model",
                  tokenizer_file="aitextgen.tokenizer.json")

  ai2.generate(10, prompt="ROMEO:")
  ```

  Want to run aitextgen and finetune GPT-2? Use the Colab notebooks in the Demos section, or [follow the documentation](https://docs.aitextgen.io/) to get more information and learn some helpful tips!



  - TPUs cannot be used to train a model: although you _can_ train an aitextgen model on TPUs by setting `n_tpu_cores=8` in an appropriate runtime, and the training loss indeed does decrease, there are a number of miscellaneous blocking problems. [[Tracking GitHub Issue](https://github.com/minimaxir/aitextgen/issues/3)]



  The current release (v0.5.X) of aitextgen **is considered to be a beta**, targeting the most common use cases. The Notebooks and examples written so far are tested to work, but more fleshing out of the docs/use cases will be done over the next few months in addition to fixing the known issues noted above.

  The next versions of aitextgen (and one of the reasons I made this package in the first place) will have native support for _schema-based generation_. (See [this repo](https://github.com/minimaxir/gpt-2-keyword-generation) for a rough proof-of-concept.)

  Additionally, I plan to develop an aitextgen [SaaS](https://en.wikipedia.org/wiki/Software_as_a_service) to allow anyone to run aitextgen in the cloud and build APIs/Twitter+Slack+Discord bots with just a few clicks. (The primary constraint is compute cost; if any venture capitalists are interested in funding the development of such a service, let me know.)

  I've listed more tentative features in the [UPCOMING](UPCOMING.md) document.



  aitextgen is a tool primarily intended to help facilitate creative content. It is not a tool intended to deceive. Although parody accounts are an obvious use case for this package, make sure you are _as upfront as possible_ with the methodology of the text you create. This includes:

  - State that the text was generated using aitextgen and/or a GPT-2 model architecture. (A link to this repo would be a bonus!)
  - If parodying a person, explicitly state that it is a parody, and reference who it is parodying.
  - If the generated text is human-curated, or if it's unsupervised random output.
  - Indicating who is maintaining/curating the AI-generated text.
  - Make a good-faith effort to remove overfit output from the generated text that matches the input text verbatim.

  It's fun to anthropomorphise the nameless "AI" as an abstract genius, but part of the reason I made aitextgen (and all my previous text-generation projects) is to make the technology more accessible and accurately demonstrate both its promise, and its limitations. **Any AI text generation projects that are deliberately deceptive may be disavowed.**



  Max Woolf ([@minimaxir](https://minimaxir.com))

  _Max's open-source projects are supported by his [Patreon](https://www.patreon.com/minimaxir) and [GitHub Sponsors](https://github.com/sponsors/minimaxir). If you found this project helpful, any monetary contributions to the Patreon are appreciated and will be put to good creative use._



  MIT


pkgId: 10ac355f0d1d842024d41f9cce608ae2a8241b7bb946243239b924bde959f046
name: python-aitomatic
arch: src
version: 1.3.1
epoch: 0
release: 1
summary: aitomatic library to interact with Aitomatic product
url: https://github.com/aitomatic/aitomatic-cli
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-aitomatic-1.3.1-1.src.rpm
checksum_type: sha256
description:
  The WebModel library is a tool for building, tuning, and inference of models that are built with the Aitomatic system. The target users of this library are AI Engineers who use the Aitomatic system.



  - Python 3.9 or higher
  - `requests` library
  - `pandas` library
  - `numpy` library
  - `tqdm` library



  The WebModel library can be installed using pip:

  ```bash
  pip install 'aitomatic>=1.2.0' --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple
  ```



  To get started, you can create a WebModel object by passing in the model name and API token:

  ```python
  from aitomatic.api.web_model import WebModel


  API_ACCESS_TOKEN = '<API_ACCESS_TOKEN>'
  project_name="<project name>"
  model_name = "<model name>"

  model = WebModel(api_token=API_ACCESS_TOKEN, project_name=project_name, model_name=model_name)
  model.load()


  print(model.stats)


  data = {'X':  my_dataframe}
  response = model.predict({'X': data})
  print(response['predictions'])
  ```



  The `WebModel` class provides several methods for working with the model:

  - **Constructor**

    ```python
    model_names = WebModel.get_model_names(api_token="YOUR_API_TOKEN", project_name="MyProject")
    ```

  - **Load model**
    `load` set up the model ready by loading all parameter from Aitomatic model repo.

    ```python
    model.load()
    ```

    - **Return** the model with loaded params

  - **Predict**
    The `predict` method takes a dictionary as input with the data you want to make predictions on. The input data should be a pandas DataFrame, Series, or numpy array with the key "X". The method returns a dictionary with the predictions, with the key "predictions".

    ```python
    response = model.predict(input_data={'X': df})
    ```

    - `input_data`: input data for prediction, dictionary with data under key 'X'
    - **Return**: result of the prediction call in a dictionary where the actual result is under `prediction` key

  - **Tuning**
    `tune_model` is a statis method to generate multiple versions of a given model with the set of input params

    ```python
    tune_model(
        project_name=PROJECT_NAME,
        base_model=BASE_MODEL_NAME,
        conclusion_tuning_range=conclusion_threshold_ranges,
        ml_tuning_params=ML_MODELS_PARAMS,
        output_model_df_path='tuning.parquet',
        wait_for_tuning_to_complete=True,
        prefix="[HUNG7]",
    )
    ```

    - `project_name`: A string containing the name of the Aitomatic project to use.
    - `base_model`:A string containing the name of the base model to use.
    - `conclusion_tuning_range`: A dictionary specifying the range of values to use for the final layer of the tuned model.
    - `ml_tuning_params`: A dictionary specifying the AutoML tuning parameters to use.
    - `output_model_df_path`: A string specifying the path to save the resulting DataFrame
      containing the tuned model's hyperparameters and performance.
    - `wait_for_tuning_to_complete`: A boolean specifying whether to wait for the tuning process
      to complete before returning. Default is True.
    - `prefix`: A string containing a prefix to add to the name of the new model. Default is "finetune".
    - **Return** A Pandas DataFrame containing the hyperparameters and performance of the tuned model.

  - **Log model metrics**
    `log_metrics` is to save the model metric after evaluation

    ```python
    model.log_metrics("accuracy", 0.95)
    ```

  - **Get models in project `static`**

    ```python
    model_names = WebModel.get_model_names(api_token="YOUR_API_TOKEN", project_name="MyProject")
    ```

    - The `api_token` A string containing the access token for the Aitomatic API. If not provided, the AITOMATIC_API_TOKEN environment variable will be used.
    - The `project_name` A string containing the name of the Aitomatic project to use. If not provided, the AITOMATIC_PROJECT_ID environment variable will be used.
    - **Return** a list of the names of all models in the specified project.


pkgId: 9d18303dcdb33016033c76c4a39795fad1b08df0fd2cc23b18ecb623fbfff521
name: python-aitta-client
arch: src
version: 0.2.0
epoch: 0
release: 1
summary: Python client for Aitta HPC ML inference platform
url: https://pypi.org/project/aitta-client/
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-aitta-client-0.2.0-1.src.rpm
checksum_type: sha256
description:
  <!--
  SPDX-FileCopyrightText: 2024 CSC - IT Center for Science Oy

  SPDX-License-Identifier: MIT
  -->



  A Python client library for the Aitta ML inference platform for HPC systems.

  Note that both the API as well as the client libary are still under heavy development and while
  we try to keep changes mostly backwards-compatible, breaking changes may happen. Access to Aitta is
  currently restricted to selected beta users.



  - `Client`: implements all requests to the Aitta API servers on a low level and is used by all other classes
  - `AccessTokenSource`: used by the client to get (and eventually refresh) access tokens
  - `Model`: represents a model and provides methods to perform inference
  - `Task`: represents an active inference task and provides methods to query the current status and results



  The below shows two examples for usage of the Aitta API using the Python client library.

  For accessing the Aitta API the client will need a way to obtain access tokens, which is
  implemented in the form of an `AccessTokenSource`. For the time being, you can generate a static
  model-specific token at the [web frontend](https://staging-aitta.2.rahtiapp.fi/) by opening
  the model's page, switching to the "API Key" tab and pressing the "Generate API key" button.

  With the token thus obtained, then have to create an instance of `StaticAccessTokenSource` for use
  with the client library.


  ```python
  from aitta_client import Model, Client, StaticAccessTokenSource


  poro_access_token = "<generate your model-specific token from https://staging-aitta.2.rahtiapp.fi/ and enter it here>"

  token_source = StaticAccessTokenSource(poro_access_token)
  client = Client("https://api-staging-aitta.2.rahtiapp.fi", token_source)


  model = Model.load("LumiOpen/Poro", client)

  print(model.description)


  inputs = {
      'input': 'Suomen paras kaupunki on'
  }

  params = {
      'do_sample': True,
      'max_new_tokens': 20
  }

  print(f"INPUT:\n{inputs}")


  result = model.start_and_await_inference(inputs, params)
  print(f"OUTPUT:\n{result}")

  ```



  ```python
  from aitta_client import Model, Client, StaticAccessTokenSource
  import openai


  poro_access_token = "<generate your model-specific token from https://staging-aitta.2.rahtiapp.fi/ and enter it here>"

  token_source = StaticAccessTokenSource(poro_access_token)
  client = Client("https://api-staging-aitta.2.rahtiapp.fi", token_source)


  model = Model.load("LumiOpen/Poro-34B-chat", client)

  print(model.description)


  client = openai.OpenAI(api_key=token_source.get_access_token(), base_url=model.openai_api_url)


  chat_completion = client.chat.completions.create(
      messages=[
          {
              "role": "user",
              "content": "Say this is a test"
          }
      ],
      model=model.id,
      stream=False  # response streaming is currently not supported by Aitta
  )

  print(chat_completion.choices[0].message.content)
  ```

rpm_license:
  MIT License  Copyright (c) <year> <copyright holders>  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


pkgId: 4f3824a3d12df7c722e6b28f7a3b7d97c1c8c1757de87831990e54e8670d206d
name: python-aitx
arch: src
version: 0.4.6
epoch: 0
release: 1
summary: The toolbox for general ML projects
url: https://github.com/jeroyang/aitx
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-aitx-0.4.6-1.src.rpm
checksum_type: sha256
description:
  [![](https://img.shields.io/travis/jeroyang/aitx.svg)](https://travis-ci.org/jeroyang/aitx)
  [![](https://img.shields.io/pypi/v/aitx.svg)](https://pypi.python.org/pypi/aitx)

  The toolbox for general ML projects



  * TODO



  ```bash
  $ python setup.py install
  ```


  ```python
  from aitx) import *
  ```

  * Free software: MIT license


pkgId: 2718280244ef983a7e65c8314d644f01013661edfe4e8aa3f4adb6ab4b96233e
name: python-aiuna
arch: src
version: 0.2103.15
epoch: 0
release: 1
summary: Science as data transformation
url: https://github.com/davips/aiuna
rpm_license: GPL3
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-aiuna-0.2103.15-1.src.rpm
checksum_type: sha256
description:
  ![test](https://github.com/davips/aiuna/workflows/test/badge.svg)
  [![codecov](https://codecov.io/gh/davips/aiuna/branch/main/graph/badge.svg)](https://codecov.io/gh/davips/aiuna)


  **WARNING: This project is still subject to major changes, e.g., in the next rewrite.**

  <p><a href="https://commons.wikimedia.org/wiki/File:Bradypus.jpg#/media/Ficheiro:Bradypus.jpg"><img src="https://upload.wikimedia.org/wikipedia/commons/1/18/Bradypus.jpg" alt="Bradypus variegatus - By Stefan Laube - (Dreizehenfaultier (Bradypus infuscatus), Gatunsee, Republik Panama), Public Domain" width="180" height="240"></a></p>





  **Creating data from ARFF file**
  <details>
  <p>

  ```python3
  from aiuna import *

  d = file("iris.arff").data

  print(d.Xd)
  """
  ['sepallength', 'sepalwidth', 'petallength', 'petalwidth']
  """
  ```

  ```python3

  print(d.X[:5])
  """
  [[5.1 3.5 1.4 0.2]
   [4.9 3.  1.4 0.2]
   [4.7 3.2 1.3 0.2]
   [4.6 3.1 1.5 0.2]
   [5.  3.6 1.4 0.2]]
  """
  ```

  ```python3

  print(d.y[:5])
  """
  ['Iris-setosa' 'Iris-setosa' 'Iris-setosa' 'Iris-setosa' 'Iris-setosa']
  """
  ```

  ```python3

  from pandas import DataFrame
  print(DataFrame(d.y).value_counts())
  """
  Iris-setosa        50
  Iris-versicolor    50
  Iris-virginica     50
  dtype: int64
  """
  ```


  </p>
  </details>

  **cessing a data field as a pandas DataFrame**
  <details>
  <p>

  ```python3











  ```


  </p>
  </details>

  **Creating data from numpy arrays**
  <details>
  <p>

  ```python3
  from aiuna import *
  import numpy as np

  X = np.array([[1, 2, 3], [4, 5, 6], [7, 8, 9]])
  y = np.array([0, 1, 1])
  d = new(X=X, y=y)
  print(d)
  """
  {
      "uuid": "06NLDM4mLEMrHPOaJvEBqdo",
      "uuids": {
          "changed": "3Sc2JjUPMlnNtlq3qdx9Afy",
          "X": "13zbQMwRwU3WB8IjMGaXbtf",
          "Y": "1IkmDz3ATFmgzeYnzygvwDu"
      },
      "step": {
          "id": "06NLDM4mLEMrHPOT2pd5lzo",
          "desc": {
              "name": "New",
              "path": "aiuna.step.new",
              "config": {
                  "hashes": {
                      "X": "586962852295d584ec08e7214393f8b2",
                      "Y": "f043eb8b1ab0a9618ad1dc53a00d759e"
                  }
              }
          }
      },
      "changed": [
          "X",
          "Y"
      ],
      "X": [
          "[[1 2 3]",
          " [4 5 6]",
          " [7 8 9]]"
      ],
      "Y": [
          "[[0]",
          " [1]",
          " [1]]"
      ]
  }
  """
  ```


  </p>
  </details>

  **Checking history**
  <details>
  <p>

  ```python3
  from aiuna import *

  d = dataset.data  # 'iris' is the default dataset
  print(d.history)
  """
  {
      "02o8BsNH0fhOYFF6JqxwaLF": {
          "name": "New",
          "path": "aiuna.step.new",
          "config": {
              "hashes": {
                  "X": "19b2d27779bc2d2444c11f5cc24c98ee",
                  "Y": "8baa54c6c205d73f99bc1215b7d46c9c",
                  "Xd": "0af9062dccbecaa0524ac71978aa79d3",
                  "Yd": "04ceed329f7c3eb43f93efd981fde313",
                  "Xt": "60d4f429fcd642bbaf1d976002479ea2",
                  "Yt": "4660adc31e2c25d02cb751dcb96ecfd3"
              }
          }
      }
  }
  """
  ```

  ```python3

  del d["X"]
  print(d.history)
  """
  {
      "02o8BsNH0fhOYFF6JqxwaLF": {
          "name": "New",
          "path": "aiuna.step.new",
          "config": {
              "hashes": {
                  "X": "19b2d27779bc2d2444c11f5cc24c98ee",
                  "Y": "8baa54c6c205d73f99bc1215b7d46c9c",
                  "Xd": "0af9062dccbecaa0524ac71978aa79d3",
                  "Yd": "04ceed329f7c3eb43f93efd981fde313",
                  "Xt": "60d4f429fcd642bbaf1d976002479ea2",
                  "Yt": "4660adc31e2c25d02cb751dcb96ecfd3"
              }
          }
      },
      "06fV1rbQVC1WfPelDNTxEPI": {
          "name": "Del",
          "path": "aiuna.step.delete",
          "config": {
              "field": "X"
          }
      }
  }
  """
  ```

  ```python3

  d["Z"] = 42
  print(d.Z, type(d.Z))
  """
  [[42]] <class 'numpy.ndarray'>
  """
  ```

  ```python3

  print(d.history)
  """
  {
      "02o8BsNH0fhOYFF6JqxwaLF": {
          "name": "New",
          "path": "aiuna.step.new",
          "config": {
              "hashes": {
                  "X": "19b2d27779bc2d2444c11f5cc24c98ee",
                  "Y": "8baa54c6c205d73f99bc1215b7d46c9c",
                  "Xd": "0af9062dccbecaa0524ac71978aa79d3",
                  "Yd": "04ceed329f7c3eb43f93efd981fde313",
                  "Xt": "60d4f429fcd642bbaf1d976002479ea2",
                  "Yt": "4660adc31e2c25d02cb751dcb96ecfd3"
              }
          }
      },
      "06fV1rbQVC1WfPelDNTxEPI": {
          "name": "Del",
          "path": "aiuna.step.delete",
          "config": {
              "field": "X"
          }
      },
      "05eIWbfCJS7vWJsXBXjoUAh": {
          "name": "Let",
          "path": "aiuna.step.let",
          "config": {
              "field": "Z",
              "value": 42
          }
      }
  }
  """
  ```


  </p>
  </details>


  Part of the effort spent in the present code was kindly supported by Fapesp under supervision of
  Prof. André C. P. L. F. de Carvalho at CEPID-CeMEAI (Grants 2013/07375-0 – 2019/01735-0).



  The novel ideias presented here are a result of a years-long
  process of drafts, thinking, trial/error and rewrittings from scratch in several languages from Delphi, passing through Haskell, Java and Scala to Python - including frustration with well stablished libraries at the time. The fundamental concepts were lightly borrowed from basic category theory concepts like algebraic data structures that permeate many recent tendencies, e.g., in programming language design.

  For more details, refer to https://github.com/davips/kururu


pkgId: 98081c88baf0fb70a596ca4a1ede037cd83dbe72740c9440162240a6e3e13c12
name: python-aiuti
arch: src
version: 0.9.2
epoch: 0
release: 1
summary: Personal collection of assorted helpers and utilities
url: https://github.com/aiudirog/Aiuti
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-aiuti-0.9.2-1.src.rpm
checksum_type: sha256
description:
  This Python package is my personal collection of helpers and utilities
  that I have written for various projects but don't have to be maintained
  with those projects.
  It has no required dependencies and is MIT licenced in order to make it
  as portable and easy to use as possible.


pkgId: e7a56e0fe5f780420f15b004751b6d321b4e6a5f705095047da5c71dff22d7fa
name: python-aiutil
arch: src
version: 0.83.0
epoch: 0
release: 1
summary: A utils Python package for data scientists.
url: https://github.com/legendu-net/aiutil
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-aiutil-0.83.0-1.src.rpm
checksum_type: sha256
description:
  This is a Python pacakage that contains misc utils for AI/ML.

  1. Misc enhancement of Python's built-in functionalities.
      - string
      - collections
      - pandas DataFrame
      - datetime
  2. Misc other tools
      - `aiutil.filesystem`: misc tools for querying and manipulating filesystems; convenient tools for manipulating text files.
      - `aiutil.url`: URL formatting for HTML, Excel, etc.
      - `aiutil.sql`: SQL formatting
      - `aiutil.cv`: some more tools (in addition to OpenCV) for image processing
      - `aiutil.shell`: parse command-line output to a pandas DataFrame
      - `aiutil.shebang`: auto correct SheBang of scripts
      - `aiutil.poetry`: tools for making it even easier to manage Python project using Poetry
      - `aiutil.pdf`: easy and flexible extracting of PDF pages
      - `aiutil.memory`: query and consume memory to a specified range
      - `aiutil.notebook`: Jupyter/Lab notebook related tools
      - `aiutil.dockerhub`: managing Docker images on DockerHub in batch mode using Python
      - `aiutil.hadoop`:
          - A Spark application log analyzing tool for identify root causes of failed Spark applications.
          - Pythonic wrappers to the `hdfs` command.
          - A auto authentication tool for Kerberos.
          - An improved version of `spark_submit`.
          - Other misc PySpark functions.



  Python 3.10.x on Linux and macOS.
  It might work on Windows but is not tested on Windows.



  ```bash
  pip3 install --user -U aiutil
  ```
  Use the following commands if you want to install all components of aiutil.
  Available additional components are `cv`, `docker`, `pdf`, `jupyter`, `admin` and `all`.
  ```bash
  pip3 install --user -U aiutil[all]
  ```


pkgId: 73a3e932a1d8fa35fe74754b93b96912b935b83571ec1b93e03063a13f830007
name: python-aivmlib
arch: src
version: 1.0.0
epoch: 0
release: 1
summary: Aivis Voice Model File (.aivm/.aivmx) Utility Library
url: https://github.com/Aivis-Project/aivmlib
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-aivmlib-1.0.0-1.src.rpm
checksum_type: sha256
description:
  **AIVM** (**Ai**vis **V**oice **M**odel) / **AIVMX** (**Ai**vis **V**oice **M**odel for ONN**X**) は、**学習済みモデル・ハイパーパラメータ・スタイルベクトル・話者メタデータ（名前・概要・ライセンス・アイコン・ボイスサンプル など）を 1 つのファイルにギュッとまとめた、AI 音声合成モデル用オープンファイルフォーマット**です。
  > [!NOTE]
  > **「AIVM」は、AIVM / AIVMX 両方のフォーマット仕様・メタデータ仕様の総称でもあります。**
  > 具体的には、AIVM ファイルは「AIVM メタデータを追加した Safetensors 形式」、AIVMX ファイルは「AIVM メタデータを追加した ONNX 形式」のモデルファイルです。
  > 「AIVM メタデータ」とは、AIVM 仕様に定義されている、学習済みモデルに紐づく各種メタデータのことをいいます。
  [AivisSpeech](https://github.com/Aivis-Project/AivisSpeech) / [AivisSpeech-Engine](https://github.com/Aivis-Project/AivisSpeech-Engine) をはじめとした AIVM 仕様に対応するソフトウェアに AIVM / AIVMX ファイルを追加することで、AI 音声合成モデルを簡単に利用できます。
  **aivmlib / [aivmlib-web](https://github.com/Aivis-Project/aivmlib-web) では、AIVM / AIVMX ファイル内のメタデータを読み書きするためのユーティリティを提供します。**
  この aivmlib は、Python で書かれた AIVM 仕様のリファレンス実装です。Web ブラウザで利用する場合は [aivmlib-web](https://github.com/Aivis-Project/aivmlib-web) をご利用ください。
  > [!TIP]
  > **[AIVM Generator](https://aivm-generator.aivis-project.com/) では、ブラウザ上の GUI でかんたんに AIVM / AIVMX ファイルを生成・編集できます。**
  > 手動で AIVM / AIVMX ファイルを生成・編集する際は AIVM Generator の利用をおすすめします。
  - [aivmlib](#aivmlib)
    - [Installation](#installation)
    - [Usage](#usage)
    - [License](#license)
  - [AIVM Specification](#aivm-specification)
    - [Overview](#overview)
    - [AIVM File Format Specification](#aivm-file-format-specification)
      - [Safetensors 形式との互換性](#safetensors-形式との互換性)
      - [参考文献](#参考文献)
    - [AIVMX File Format Specification](#aivmx-file-format-specification)
      - [ONNX 形式との互換性](#onnx-形式との互換性)
      - [参考文献](#参考文献-1)
    - [AIVM Manifest Specification (Version 1.0)](#aivm-manifest-specification-version-10)
      - [サポートされるモデルアーキテクチャ](#サポートされるモデルアーキテクチャ)
      - [AIVM マニフェストのフィールド定義](#aivm-マニフェストのフィールド定義)
    - [FAQ](#faq)
      - [Q. AIVM と AIVMX という 2 つのフォーマットが定義されているのはなぜですか？](#q-aivm-と-aivmx-という-2-つのフォーマットが定義されているのはなぜですか)
      - [Q. AIVM / AIVMX ファイルを既存のツールで読み込むことはできますか？](#q-aivm--aivmx-ファイルを既存のツールで読み込むことはできますか)
      - [Q. 既存の AI 音声合成モデルを AIVM / AIVMX に変換するにはどうすればよいですか？](#q-既存の-ai-音声合成モデルを-aivm--aivmx-に変換するにはどうすればよいですか)
      - [Q. AIVM マニフェストのバージョン管理はどのように行われますか？](#q-aivm-マニフェストのバージョン管理はどのように行われますか)
      - [Q. aivmlib と aivmlib-web の違いはなんですか？](#q-aivmlib-と-aivmlib-web-の違いはなんですか)
      - [Q. 新しいモデルアーキテクチャのサポートを追加するにはどうすればよいですか？](#q-新しいモデルアーキテクチャのサポートを追加するにはどうすればよいですか)
      - [Q. ライセンス情報はどのように記述すべきですか？](#q-ライセンス情報はどのように記述すべきですか)
      - [Q. 画像・音声データのサイズ制限はありますか？](#q-画像音声データのサイズ制限はありますか)
      - [Q. メタデータは手動で編集できますか？](#q-メタデータは手動で編集できますか)

  pip でインストールすると、コマンドラインツール `aivmlib` も自動的にインストールされます。
  Python 3.11 以上が必要です。
  ```bash
  pip install aivmlib
  ```
  開発時は Poetry を利用しています。
  ```bash
  pip install poetry
  git clone https://github.com/Aivis-Project/aivmlib.git
  cd aivmlib
  poetry install --with dev
  poetry run aivmlib --help
  ```

  以下に CLI ツール自体の使い方を示します。
  ```bash
  $ aivmlib --help
   Usage: aivmlib [OPTIONS] COMMAND [ARGS]...
   Aivis Voice Model File (.aivm/.aivmx) Utility Library
  ╭─ Options ─────────────────────────────────────────────────────────────────────────╮
  │ --install-completion          Install completion for the current shell.           │
  │ --show-completion             Show completion for the current shell, to copy it   │
  │                               or customize the installation.                      │
  │ --help                        Show this message and exit.                         │
  ╰───────────────────────────────────────────────────────────────────────────────────╯
  ╭─ Commands ────────────────────────────────────────────────────────────────────────╮
  │ create-aivm    与えられたアーキテクチャ, 学習済みモデル, ハイパーパラメータ,      │
  │                スタイルベクトルから AIVM メタデータを生成した上で、               │
  │                それを書き込んだ仮の AIVM ファイルを生成する                       │
  │ create-aivmx   与えられたアーキテクチャ, 学習済みモデル, ハイパーパラメータ,      │
  │                スタイルベクトルから AIVM メタデータを生成した上で、               │
  │                それを書き込んだ仮の AIVMX ファイルを生成する                      │
  │ show-metadata  指定されたパスの AIVM / AIVMX ファイル内に記録されている AIVM      │
  │                メタデータを見やすく出力する                                       │
  ╰───────────────────────────────────────────────────────────────────────────────────╯
  $ aivmlib show-metadata --help
   Usage: aivmlib show-metadata [OPTIONS] FILE_PATH
   指定されたパスの AIVM / AIVMX ファイル内に記録されている AIVM メタデータを見やすく出力する
  ╭─ Arguments ───────────────────────────────────────────────────────────────────────╮
  │ *    file_path      PATH  Path to the AIVM / AIVMX file [default: None]           │
  │                           [required]                                              │
  ╰───────────────────────────────────────────────────────────────────────────────────╯
  ╭─ Options ─────────────────────────────────────────────────────────────────────────╮
  │ --help          Show this message and exit.                                       │
  ╰───────────────────────────────────────────────────────────────────────────────────╯
  $ aivmlib create-aivm --help
   Usage: aivmlib create-aivm [OPTIONS]
   与えられたアーキテクチャ, 学習済みモデル, ハイパーパラメータ, スタイルベクトルから
   AIVM メタデータを生成した上で、それを書き込んだ仮の AIVM ファイルを生成する
  ╭─ Options ─────────────────────────────────────────────────────────────────────────╮
  │ *  --output              -o      PATH                    Path to the output AIVM  │
  │                                                          file                     │
  │                                                          [default: None]          │
  │                                                          [required]               │
  │ *  --model               -m      PATH                    Path to the Safetensors  │
  │                                                          model file               │
  │                                                          [default: None]          │
  │                                                          [required]               │
  │    --hyper-parameters    -h      PATH                    Path to the hyper        │
  │                                                          parameters file          │
  │                                                          (optional)               │
  │                                                          [default: None]          │
  │    --style-vectors       -s      PATH                    Path to the style        │
  │                                                          vectors file (optional)  │
  │                                                          [default: None]          │
  │    --model-architecture  -a      [Style-Bert-VITS2|Styl  Model architecture       │
  │                                  e-Bert-VITS2            [default:                │
  │                                  (JP-Extra)]             Style-Bert-VITS2         │
  │                                                          (JP-Extra)]              │
  │    --help                                                Show this message and    │
  │                                                          exit.                    │
  ╰───────────────────────────────────────────────────────────────────────────────────╯
  $ aivmlib create-aivmx --help
   Usage: aivmlib create-aivmx [OPTIONS]
   与えられたアーキテクチャ, 学習済みモデル, ハイパーパラメータ, スタイルベクトルから
   AIVM メタデータを生成した上で、それを書き込んだ仮の AIVMX ファイルを生成する
  ╭─ Options ─────────────────────────────────────────────────────────────────────────╮
  │ *  --output              -o      PATH                    Path to the output AIVMX │
  │                                                          file                     │
  │                                                          [default: None]          │
  │                                                          [required]               │
  │ *  --model               -m      PATH                    Path to the ONNX model   │
  │                                                          file                     │
  │                                                          [default: None]          │
  │                                                          [required]               │
  │    --hyper-parameters    -h      PATH                    Path to the hyper        │
  │                                                          parameters file          │
  │                                                          (optional)               │
  │                                                          [default: None]          │
  │    --style-vectors       -s      PATH                    Path to the style        │
  │                                                          vectors file (optional)  │
  │                                                          [default: None]          │
  │    --model-architecture  -a      [Style-Bert-VITS2|Styl  Model architecture       │
  │                                  e-Bert-VITS2            [default:                │
  │                                  (JP-Extra)]             Style-Bert-VITS2         │
  │                                                          (JP-Extra)]              │
  │    --help                                                Show this message and    │
  │                                                          exit.                    │
  ╰───────────────────────────────────────────────────────────────────────────────────╯
  ```
  以下にコマンドの実行例を示します。
  ```bash



  $ aivmlib create-aivm -o ./output.aivm -m ./model.safetensors

  $ aivmlib create-aivm -o ./output.aivm -m ./model.safetensors -h ./config.json -s ./style-vectors.npy


  $ aivmlib create-aivmx -o ./output.aivmx -m ./model.onnx -a "Style-Bert-VITS2"

  $ aivmlib create-aivmx -o ./output.aivmx -m ./model.onnx -a "Style-Bert-VITS2" -h ./config.json -s ./style-vectors.npy

  $ aivmlib show-metadata ./output.aivm

  $ aivmlib show-metadata ./output.aivmx
  ```
  > [!TIP]
  > **ライブラリとしての使い方は、[`__main__.py`](aivmlib/__main__.py) に実装されている CLI ツールの実装を参照してください。**
  > [!IMPORTANT]
  > **aivmlib / [aivmlib-web](https://github.com/Aivis-Project/aivmlib-web) は、AIVM / AIVMX ファイルフォーマットの読み込み/書き込み機能のみを有するライブラリです。**
  > 各モデルアーキテクチャごとの AI 音声合成モデルの推論ロジックや、aivmlib / aivmlib-web から取得したデータをどのようにユーザーに提示するかは、すべてライブラリの利用者に委ねられています。

  [MIT License](LICENSE)
  <br>

  このセクションでは、「AIVM 仕様」に含まれる、下記の技術仕様を定義する。
  <!-- no toc -->
  - [AIVM File Format Specification](#aivm-file-format-specification)
  - [AIVMX File Format Specification](#aivmx-file-format-specification)
  - [AIVM Manifest Specification (Version 1.0)](#aivm-manifest-specification-version-10)
  - [FAQ](#faq)

  学習済み AI 音声合成モデルと、その利用に必要な各種メタデータを単一ファイルにまとめることで、**ファイルの散逸や混乱を防ぎ、モデルの利用や共有を容易にすることを目的としている。**
  > [!TIP]
  > 単一ファイルにまとめることで、AIVM / AIVMX ファイルをダウンロードして所定のフォルダに配置するだけで、対応ソフトウェアですぐに音声合成モデルを利用できるようになるといった、シンプルな運用が可能になる。
  > 圧縮ファイルではないため、展開の必要がないのもメリット。
  **AIVM 仕様は、音声合成モデルのモデルアーキテクチャに依存しない。**
  異なるモデルアーキテクチャの音声合成モデルを共通のファイルフォーマットで扱えるよう、将来的な拡張性や汎用性を考慮して設計されている。
  大元の学習済みモデルが単一の Safetensors または ONNX 形式で保存されているならば、原則どのようなモデルアーキテクチャであっても、メタデータを追加して AIVM / AIVMX ファイルを生成できる。
  設計にあたっては、変換処理を挟むことなく通常の Safetensors ファイルや ONNX ファイルとしてロードできるよう、既存エコシステムとの互換性を重視した。
  > [!IMPORTANT]
  > **AIVM 仕様は、各モデルアーキテクチャごとの推論方法を定義しない。あくまでも「AI 音声合成モデルのメタデータをまとめたファイル」としての仕様のみを定義する。**
  > たとえば AIVM ファイルの場合、格納されている AI 音声合成モデルは PyTorch 用かもしれないし、TensorFlow 用かもしれない。
  > どのように AI 音声合成モデルの推論を行うかは、AIVM / AIVMX ファイルをサポートするソフトウェアの実装に委ねられている。

  以下に、AIVM ファイルフォーマットの仕様を示す。
  **AIVM** (**Ai**vis **V**oice **M**odel) は、[Safetensors](https://github.com/huggingface/safetensors) (.safetensors) 形式で保存された学習済みモデルのヘッダー領域の中に、カスタムメタデータとして話者メタデータ ([AIVM マニフェスト](#aivm-manifest-specification-version-10)) ・ハイパーパラメータ・スタイルベクトルといった各種情報を格納した、Safetensors 形式の拡張仕様である。
  **「Safetensors 形式で保存された AI 音声合成モデル向けの、共通メタデータ記述仕様」** とも言える。

  Safetensors 形式の拡張仕様のため、そのまま通常の Safetensors ファイルとしてロードできる。
  Safetensors 同様、先頭 8bytes の符号なし Little-Endian 64bit 整数がヘッダーサイズ、その後ろにヘッダーサイズの長さだけ UTF-8 の JSON 文字列が続く。
  Safetensors のヘッダー JSON にはテンソルのオフセット等が格納されているが、`__metadata__` キーには string から string への map を自由に設定可能な仕様である。
  この仕様を活用し、AIVM は `__metadata__` 内の以下のキーに、次の文字列データを格納する：
  - **`aivm_manifest` : [AIVM マニフェスト](#aivm-manifest-specification-version-10)**
    - JSON 文字列として格納される
    - マニフェストバージョンや話者メタデータを含む大半の情報が含まれる
  - **`aivm_hyper_parameters` : 音声合成モデルのハイパーパラメータ**
    - 格納フォーマットはモデルアーキテクチャ依存
    - `Style-Bert-VITS2`・`Style-Bert-VITS2 (JP-Extra)` モデルアーキテクチャでは JSON 文字列が格納される
  - **`aivm_style_vectors` : Base64 エンコードされた音声合成モデルのスタイルベクトル (バイナリ)**
    - Base64 デコード後のフォーマットはモデルアーキテクチャ依存
    - `Style-Bert-VITS2`・`Style-Bert-VITS2 (JP-Extra)` モデルアーキテクチャでは NumPy 配列 (.npy) を Base64 エンコードした文字列が格納される
    - モデルアーキテクチャ次第では省略されうる

  - [Safetensors](https://github.com/huggingface/safetensors)
  - [Safetensors Metadata Parsing](https://huggingface.co/docs/safetensors/main/en/metadata_parsing)

  以下に、AIVMX ファイルフォーマットの仕様を示す。
  **AIVMX** (**Ai**vis **V**oice **M**odel for ONN**X**) は、[ONNX](https://onnx.ai/) 形式で保存された学習済みモデルのメタデータ領域の中に、カスタムメタデータとして話者メタデータ ([AIVM マニフェスト](#aivm-manifest-specification-version-10)) ・ハイパーパラメータ・スタイルベクトルといった各種情報を格納した、ONNX 形式の拡張仕様である。
  **「ONNX 形式で保存された AI 音声合成モデル向けの、共通メタデータ記述仕様」** とも言える。

  ONNX 形式の拡張仕様のため、そのまま通常の ONNX ファイルとしてロードできる。
  ONNX ファイルは Protocol Buffers 形式で定義されており、ルートである `ModelProto` メッセージの `metadata_props` フィールドに、`StringStringEntryProto` のリストとしてメタデータを格納できる仕様となっている。
  この仕様を活用し、AIVMX は `metadata_props` 内の以下のキーに、次の文字列データを格納する：
  - **`aivm_manifest` : [AIVM マニフェスト](#aivm-manifest-specification-version-10)**
    - JSON 文字列として格納される
    - マニフェストバージョンや話者メタデータを含む大半の情報が含まれる
  - **`aivm_hyper_parameters` : 音声合成モデルのハイパーパラメータ**
    - 格納フォーマットはモデルアーキテクチャ依存
    - `Style-Bert-VITS2`・`Style-Bert-VITS2 (JP-Extra)` モデルアーキテクチャでは JSON 文字列が格納される
  - **`aivm_style_vectors` : Base64 エンコードされた音声合成モデルのスタイルベクトル (バイナリ)**
    - Base64 デコード後のフォーマットはモデルアーキテクチャ依存
    - `Style-Bert-VITS2`・`Style-Bert-VITS2 (JP-Extra)` モデルアーキテクチャでは NumPy 配列 (.npy) を Base64 エンコードした文字列が格納される
    - モデルアーキテクチャ次第では省略されうる

  - [ONNX](https://onnx.ai/)
  - [Open Neural Network Exchange Intermediate Representation (ONNX IR) Specification](https://onnx.ai/onnx/repo-docs/IR.html#optional-metadata)
  - [ONNX Metadata](https://onnx.ai/onnx/repo-docs/MetadataProps.html)
  - [How to populate onnx model with custom meta data map ?](https://github.com/onnx/sklearn-onnx/issues/214)

  以下に、AIVM / AIVMX ファイルフォーマットに含まれる、AIVM マニフェスト (Version 1.0) の仕様を示す。
  **AIVM マニフェストには、マニフェストバージョン・モデルアーキテクチャ・モデル名・話者メタデータ・スタイル情報などの、音声合成モデルの利用に必要となる様々な情報が含まれる。**
  AIVM マニフェストのデータ形式は、JSON フォーマットで記述された UTF-8 文字列である。
  JSON フォーマットの都合上、画像や音声データは Base64 エンコードされた文字列で格納される。
  > [!NOTE]
  > 現在 AIVM マニフェストのコンテナフォーマットとして定義されている AIVM (Safetensors) ・AIVMX (ONNX) のメタデータ領域はネストなしの string 型から string 型への key-value でなければならないため、すべてのメタデータを文字列にシリアライズして格納する仕様となっている。
  > 画像や音声などのバイナリデータについては、Base64 エンコードを施した上で文字列として格納する。

  - `Style-Bert-VITS2`
  - `Style-Bert-VITS2 (JP-Extra)`
  > [!IMPORTANT]
  > **AIVM / AIVMX ファイルをサポートするソフトウェアでは、自ソフトウェアではサポート対象外のモデルアーキテクチャの AIVM / AIVMX ファイルを、適切にバリデーションする必要がある。**
  > たとえば `Style-Bert-VITS2 (JP-Extra)` 以外のモデルアーキテクチャをサポートしないソフトウェアでは、`Style-Bert-VITS2` モデルアーキテクチャの AIVM / AIVMX ファイルのインストールを求められた際に「このモデルアーキテクチャには対応していません」とアラートを表示し、インストールを中止するよう実装すべき。
  > [!IMPORTANT]
  > **技術的には上記以外のモデルアーキテクチャの音声合成モデルも格納可能だが、AIVM マニフェスト (Version 1.0) 仕様で公式に定義されているモデルアーキテクチャ文字列は上記のみ。**
  > 独自にモデルアーキテクチャ文字列を定義する場合は、既存のモデルアーキテクチャとの名前衝突や異なるソフト間での表記揺れが発生しないよう、細心の注意を払う必要がある。
  > なるべくこのリポジトリにプルリクエストを送信し、公式に AIVM 仕様に新しいモデルアーキテクチャのサポートを追加する形を取ることを推奨する。

  以下は AIVM マニフェスト (Version 1.0) 仕様時点での AIVM マニフェストのフィールド定義を示す ([aivmlib の Pydantic スキーマ定義](aivmlib/schemas/aivm_manifest.py) より抜粋) 。
  > [!IMPORTANT]
  > **AIVM マニフェスト内のフィールドは、今後 AIVM 仕様が更新された際に追加・拡張・削除される可能性がある。**
  > 今後のバージョン更新や追加のモデルアーキテクチャのサポートにより、AIVM マニフェストや AIVM / AIVMX ファイルフォーマット自体に新しいメタデータが追加されることも十分考えられる。
  > 現在有効な AIVM マニフェストバージョンは `1.0` のみ。
  ```python
  class ModelArchitecture(StrEnum):
      StyleBertVITS2 = 'Style-Bert-VITS2'  # 対応言語: "ja", "en-US", "zh-CN"
      StyleBertVITS2JPExtra = 'Style-Bert-VITS2 (JP-Extra)'  # 対応言語: "ja"
  class ModelFormat(StrEnum):
      Safetensors = 'Safetensors'
      ONNX = 'ONNX'
  class AivmManifest(BaseModel):
      """ AIVM マニフェストのスキーマ """
      
      
      manifest_version: Literal['1.0']
      
      
      name: Annotated[str, StringConstraints(min_length=1, max_length=80)]
      
      description: Annotated[str, StringConstraints(max_length=140)] = ''
      
      
      
      creators: list[Annotated[str, StringConstraints(min_length=1, max_length=255)]] = []
      
      
      
      license: Annotated[str, StringConstraints(min_length=1)] | None = None
      
      model_architecture: ModelArchitecture
      
      
      model_format: ModelFormat
      
      training_epochs: Annotated[int, Field(ge=0)] | None = None
      
      training_steps: Annotated[int, Field(ge=0)] | None = None
      
      uuid: UUID
      
      version: Annotated[str, StringConstraints(pattern=r'^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$')]
      
      speakers: list[AivmManifestSpeaker]
  class AivmManifestSpeaker(BaseModel):
      """ AIVM マニフェストの話者情報 """
      
      
      name: Annotated[str, StringConstraints(min_length=1, max_length=80)]
      
      
      icon: Annotated[str, StringConstraints(pattern=r'^data:image/(jpeg|png);base64,[A-Za-z0-9+/=]+$')]
      
      
      supported_languages: list[Annotated[str, StringConstraints(pattern=r'^[a-z]{2,3}(?:-[A-Z]{4})?(?:-(?:[A-Z]{2}|\d{3}))?(?:-(?:[A-Za-z0-9]{5,8}|\d[A-Za-z0-9]{3}))*(?:-[A-Za-z](?:-[A-Za-z0-9]{2,8})+)*(?:-x(?:-[A-Za-z0-9]{1,8})+)?$')]]
      
      uuid: UUID
      
      local_id: Annotated[int, Field(ge=0)]
      
      styles: list[AivmManifestSpeakerStyle]
  class AivmManifestSpeakerStyle(BaseModel):
      """ AIVM マニフェストの話者スタイル情報 """
      
      name: Annotated[str, StringConstraints(min_length=1, max_length=20)]
      
      
      
      icon: Annotated[str, StringConstraints(pattern=r'^data:image/(jpeg|png);base64,[A-Za-z0-9+/=]+$')] | None = None
      
      local_id: Annotated[int, Field(ge=0, le=31)]  # 最大 32 スタイルまでサポート
      
      voice_samples: list[AivmManifestVoiceSample] = []
  class AivmManifestVoiceSample(BaseModel):
      """ AIVM マニフェストのボイスサンプル情報 """
      
      
      audio: Annotated[str, StringConstraints(pattern=r'^data:audio/(wav|mp4);base64,[A-Za-z0-9+/=]+$')]
      
      
      transcript: Annotated[str, StringConstraints(min_length=1)]
  ```


  **A. 異なる用途や環境に最適化された 2 つのフォーマットを提供することで、より柔軟な利用を可能にするためです。**
  - **AIVM (.aivm): PyTorch などの機械学習フレームワークで直接利用できる [Safetensors](https://huggingface.co/docs/safetensors/index) 形式をベースとしたフォーマットです。**
    - 研究開発やモデルの Fine-Tuning 、モデルマージによる新たな声質生成などに適しています。
    - 一般に、NVIDIA GPU (CUDA / TensorRT など) での高速推論に特化しています。
    - PyTorch には .pth (pickle) 形式もありますが、Python コードをそのままシリアライズする pickle の特性上、任意コードの実行が可能な脆弱性があります。したがって、AIVM 仕様では対応予定はありません。
  - **AIVMX (.aivmx): 様々な環境で高速な推論が可能な [ONNX](https://onnx.ai/) 形式をベースとしたフォーマットです。**
    - 特に CPU での推論や、エッジデバイスでの利用に適しています。また Web ブラウザでも推論可能です。
    - 2024 年時点では、一般的な PC ユーザーの多くは NVIDIA GPU や NPU を搭載していない PC を使用しています。
      - ONNX 形式は CPU での推論性能に優れているため、GPU や NPU がなくても快適に音声合成を実行できます。
      - さらに ONNX 形式は DirectML 推論をサポートしており、Windows では AMD Radeon / Intel Arc GPU でも高速推論が可能です。
    - **AIVM 仕様対応ソフトウェアのリファレンス実装でもある [AivisSpeech](https://github.com/Aivis-Project/AivisSpeech) は AIVMX ファイルにのみ対応しています。**
      - PyTorch 依存を排除してインストールサイズを削減し、同時に CPU 推論速度を向上させるためです。

  **A. はい、可能です。**
  AIVM は Safetensors 形式の、AIVMX は ONNX 形式の拡張仕様として設計されているため、それぞれ通常の Safetensors ファイル・ONNX ファイルとして読み込むことができます。
  AIVM メタデータは既存のモデルフォーマット仕様で定められたメタデータ領域に格納されているため、既存のツールの動作に影響を与えることはありません。

  **A. 以下の2つの方法があります。**
  1. **[AIVM Generator](https://aivm-generator.aivis-project.com/) (推奨)**: ブラウザ上の GUI で簡単に AIVM / AIVMX ファイルを生成・編集できます。
  2. **aivmlib**: このライブラリが提供する CLI ツールを使用して、コマンドラインから最低限のメタデータが設定された AIVM / AIVMX ファイルを生成できます。
     - ハイパーパラメータなどから変換した最低限のメタデータのみ設定されているため、実際に配布する際は別途メタデータを編集する必要があります。
  なお、変換元のモデルは単一の Safetensors または ONNX 形式で保存されている必要があります。

  **A. AIVM マニフェストのバージョン管理は以下の方針で行われます。**
  - **マイナーバージョンアップ (ex: 1.0 -> 1.1)**: 新しいフィールドの追加など、後方互換性が保たれた変更
  - **メジャーバージョンアップ (ex: 1.1 -> 2.0)**: 既存フィールドの削除や構造変更など、後方互換性のない変更
  現在は 1.0 が最新です。

  **A. aivmlib と aivmlib-web は、同じ AIVM 仕様を異なる言語/動作環境向けに実装したライブラリになります。**
  - **aivmlib**: Python 実装。デスクトップアプリケーションやサーバーサイドでの利用を想定しています。
    - NVIDIA GPU 搭載の高火力サーバーで運用するケースでは、モデルアーキテクチャや推論環境次第ですが、AIVMX (ONNX) 形式よりも AIVM (Safetensors) 形式の方が高速な可能性もあります。
    - aivmlib は aivmlib-web のリファレンス実装でもあります。新しい仕様を実装する際は、まず aivmlib に実装してから、aivmlib-web に移植する形をとっています。
  - **aivmlib-web**: TypeScript 実装。Web ブラウザ上での利用を想定しています。
    - [AIVM Generator](https://aivm-generator.aivis-project.com/) や Web ブラウザ上で音声合成を行うサービスで使うことを前提に設計・開発されています。
    - AIVM と AIVMX 両方のファイルを扱えます（主に AIVM Generator 向け）。
      - Web ブラウザで推論可能なモデルフォーマットは基本的に ONNX 形式に限られるため、実運用上は AIVMX ファイルのみ扱うケースがほとんどのはずです。
    - Python の `BinaryIO` が JavaScript Web API の `File` (Blob) になるなど、Web ブラウザの特性に応じた実装の違いはありますが、基本的な API 設計は aivmlib と同様です。
      - Node.js や Deno などのサーバーサイド JavaScript 環境への対応予定はありません。
  > [!TIP]
  > 現時点では、aivmlib / [aivmlib-web](https://github.com/Aivis-Project/aivmlib-web) 以外に、公式にメンテナンスされる AIVM 仕様対応ライブラリはありません。
  > 今後、サードパーティーの他言語向けライブラリが登場する可能性はあります。
  > [!IMPORTANT]
  > **新しいモデルアーキテクチャのサポートを追加する際は、aivmlib と [aivmlib-web](https://github.com/Aivis-Project/aivmlib-web) の両方に実装を追加する必要があります。**
  > AIVM Generator は aivmlib-web を使用しているため、エンドユーザーに新機能を提供するためには両方のライブラリをアップデートする必要があります。

  **A. AIVM 仕様はモデルアーキテクチャの実装詳細を規定しないため、比較的容易に新しいモデルアーキテクチャを追加できます。**
  1. **AIVM マニフェスト内のメタデータだけで対応できる場合**: `ModelArchitecture` に新しい種類（例: `GPT-SoVITS2`）を追加するプルリクエストを送信するだけで対応可能です。
     - その際、なるべく同時に `generate_aivm_metadata()` 関数に新しいモデルアーキテクチャのサポートを追加してください。
  2. **モデルアーキテクチャ固有のメタデータの追加が必要な場合**: `aivm_style_vectors` フィールドのように、AIVM マニフェストとは別のメタデータキーを新設する仕様を策定した上で、プルリクエストを送信してください。
     - なるべく aivmlib (Python) と [aivmlib-web](https://github.com/Aivis-Project/aivmlib-web) (TypeScript Web) の両方でサポートできる仕様が望ましいです。
     - 当該モデルアーキテクチャが Web で推論可能な ONNX 形式に対応していない場合、推論時のみ必要なメタデータに関しては、aivmlib-web で対応可能な仕様である必要はありません。
     - AIVM マニフェストに追加するメタデータは、aivmlib-web でもサポートできるものでなければなりません（後述）。
  > [!IMPORTANT]
  > **提出される AIVM マニフェスト仕様は、技術的に aivmlib (Python) と [aivmlib-web](https://github.com/Aivis-Project/aivmlib-web) (TypeScript Web) の両方でサポートできるものでなければなりません。**
  > AIVM Generator の内部では aivmlib-web が利用されています。
  > **aivmlib にサポートを追加したら、aivmlib-web にも同様にサポートを追加してください。**
  > [!NOTE]
  > **AIVM マニフェストは、モデルアーキテクチャに依存しない共通のメタデータのみを定義する設計としています。**
  > 実装固有のハイパーパラメータは、`aivm_hyper_parameters` フィールドに格納してください。
  > ハイパーパラメータの Pydantic スキーマ定義の追加も受け付けます。現在は `Style-Bert-VITS2` 系アーキテクチャのハイパーパラメータのスキーマのみが定義されています。
  > [!NOTE]
  > 当然ですが、AIVM / AIVMX への変換元モデルは単一の Safetensors または ONNX 形式で保存されている必要があります。
  > **したがって、複数のモデルファイルにまたがるモデルアーキテクチャはサポートされていません。**
  > モデルファイルを一つに結合する、不要なモデルファイルを削るなどの対応をご検討ください。

  **A. ライセンス情報は Markdown 形式またはプレーンテキストで、ライセンスの全文のコピーを AIVM / AIVMX ファイルに直接埋め込む形で設定します。**
  URL 指定ではなくライセンス全文を埋め込む理由は以下の通りです。
  - URL の永続性が保証できない
  - URL だけだとライセンス名が分からない
  - カスタムライセンスの規定が難しい
  - AIVM 仕様対応ソフトウェアでライセンス情報を直接表示できる必要がある

  **A. 具体的なサイズ制限は規定していませんが、一般にモデルファイル自体のファイルサイズが巨大なため、メタデータによるさらなるファイルサイズ増加は最小限に抑えるべきです。**
  - 画像ファイル: 512×512 の JPEG または PNG (JPEG を推奨)
  - 音声ファイル: WAV (PCM 16bit) または M4A (AAC-LC) (M4A を推奨)
  > [!TIP]
  > リファレンス実装である [AIVM Generator](https://aivm-generator.aivis-project.com/) では、これらのガイドラインに従って適切なサイズ最適化を行っています。

  **A. メタデータは直接バイナリに埋め込まれるため、手動編集は推奨されません。**
  エンドユーザーの方は [AIVM Generator](https://aivm-generator.aivis-project.com/) をご利用ください。
  > [!TIP]
  > **開発者は、aivmlib / [aivmlib-web](https://github.com/Aivis-Project/aivmlib-web) を使用して独自のアプリケーションを作成できます。**
  > aivmlib CLI は、最低限のメタデータを持つ AIVM / AIVMX ファイルの生成と、メタデータの確認機能のみを提供します。


pkgId: b1ae275e140c8c13a2f1a29f45fe2dea8728444f0a10662718d7e369b389a331
name: python-aivoifu
arch: src
version: 0.2.9
epoch: 0
release: 1
summary: Easy and fast AI Waifu voice generation
url: https://pypi.org/project/aivoifu/
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
location_href: Packages/python-aivoifu-0.2.9-1.src.rpm
checksum_type: sha256
description:
  Waifu Voice - Made Easy


  an implementation of AIwaifu Vocal Pipeline to make it easier to create a fast and easy-to-use Cute Waifu Voice
  Text -> TTS -> Voice Conversion -> Done


  ```bash

  poetry install aivoifu # Recommended using poetry
  ```
  ```python
  from AIvoifu import client_pipeline

  model = client_pipeline.tts_pipeline(tts_model_selection='gtts', vc_model_selection='ayaka-jp', hubert_model='zomehwh-hubert-base', language='en')
  model.tts('Hello This Is A Test Text Anyway', save_path='./test.wav')
  ```


  First of all we need to understand how AIwaifu Vocal Pipeline was design
  There's two components
  1. TTS: This is a typical text to speech model which you can add your own
  2. Voice_Conversion: This is our Heroine on making TTS sound like a cute girl by converting TTS speech using Voice Conversion which you can train easily

  First of all we get TTS voice from TTS pipeline, adn the we do voice conversion on it

  in the TTS folder you'll found
  - tts_base_model: folder
  - tts.py

  if you wish to add your own TTS model please create a class in tts.py
  and in the function constructor please download the weight and cache it
  under the tts_base_model along with other cache file
  ```python

  class CustomTTS:
    def __init__(self) -> None:
      from something import tts_library
      self.model_link = 'Huggingface_link'
      root = os.path.dirname(os.path.abspath(__file__))
      self.model_root_path = f'{root}/base_tts_model/'
      self.model_name = 'custom_tts'
      model_path = f'{self.model_root_path}/{self.model_name}'
      if not os.path.exist(model_path)
        os.mkdir(model_path)
      weigh_path = f'{model_path}/{self.model_name}.pth'
      if not os.path.exist(weigh_path):
        wget.download(self.model_link, weigh_path)
      self.model = tts_library.load(weigh_path)
      print(f'model {self.model_name} initialized')

    def tts(self, text:str, save:boolean=True, your_args:any):
      
      output = self.model.tts(text)
      if save:
        output.save('save_path')
      return output
  ```

  if you're not looking to add new language but just want to custom the model voice easily

  Our recommendation is to just Train Voice Conversion pipeline on your own samples and added it to the zoo


