Skip to main content
Version: 1.0

aixplain.modules.metadata

__author__​

Copyright 2022 The aiXplain SDK authors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Author: aiXplain team Date: March 20th 2023 Description: Meta-data Class

MetaData Objects​

class MetaData()

[view_source]

A class representing metadata for data in the aiXplain platform.

This class provides functionality for managing metadata, which is used to store information about data in the platform. It supports various data types, languages, and storage formats.

Attributes:

  • name Text - Name of the data.
  • dtype DataType - Type of data.
  • storage_type StorageType - Storage type of the data.
  • data_column Optional[Text] - Column index/name where the data is on a structured file.
  • start_column Optional[Text] - Column index/name where the start indexes is on a structured file.
  • end_column Optional[Text] - Column index/name where the end indexes is on a structured file.
  • privacy Optional[Privacy] - Privacy of data.
  • file_extension Optional[FileType] - File extension (e.g. CSV, TXT, etc.).
  • languages List[Language] - List of languages which the data consists of.
  • dsubtype DataSubtype - Data subtype (e.g., age, topic, race, split, etc.), used in datasets metadata.
  • dtype0 Optional[Text] - Data ID.
  • dtype1 dict - Additional keyword arguments for extensibility.

__init__​

def __init__(name: Text,
             dtype: DataType,
             storage_type: StorageType,
             data_column: Optional[Text] = None,
             start_column: Optional[Text] = None,
             end_column: Optional[Text] = None,
             privacy: Optional[Privacy] = None,
             file_extension: Optional[FileType] = None,
             languages: List[Language] = [],
             dsubtype: DataSubtype = DataSubtype.OTHER,
             id: Optional[Text] = None,
             **kwargs) -> None

[view_source]

Initialize a new MetaData instance.

Arguments:

  • name Text - Data Name
  • dtype DataType - Data Type
  • storage_type StorageType - Data Storage (e.g. text, local file, web link)
  • data_column Optional[Text], optional - Column index/name where the data is on a structured file (e.g. CSV). Defaults to None.
  • start_column Optional[Text], optional - Column index/name where the start indexes is on a structured file (e.g. CSV). Defaults to None.
  • end_column Optional[Text], optional - Column index/name where the end indexes is on a structured file (e.g. CSV). Defaults to None.
  • privacy Optional[Privacy], optional - Privacy of data. Defaults to None.
  • file_extension Optional[FileType], optional - File extension (e.g. CSV, TXT, etc.). Defaults to None.
  • languages List[Language], optional - List of languages which the data consists of. Defaults to [].
  • dsubtype DataSubtype, optional - Data subtype (e.g., age, topic, race, split, etc.), used in datasets metadata. Defaults to Other.
  • dtype0 Optional[Text], optional - Data ID. Defaults to None.