Dataset Types

class indico.types.dataset.Dataset(**kwargs)

A Dataset in the Indico Platform

id

The Dataset id

• Type:
  int

name

Dataset name

• Type:
  str

row_count

Number of rows in the dataset

• Type:
  int

permissions

Permissions on the dataset

• Type:
  str

files

Names of the file(s) included in the dataset

• Type:
  List[Datafile]

labelsets

LabelSets associated with this dataset

• Type:
  List[LabelSet]

datacolumns

DataColumn(s) of the dataset

• Type:
  List[DataColumn]

class indico.types.dataset.DataColumn(**kwargs)

A DataColumn in the Indico Platform

id

The DataColumn id

• Type:
  int

name

DataColumn name

• Type:
  str

class indico.types.dataset.LabelSet(**kwargs)

A LabelSet in the Indico Platform

id

The LabelSet id

• Type:
  int

name

LabelSet name

• Type:
  str

class indico.types.datafile.Datafile(**kwargs)

A Datafile in the Indico Platform.

Datafiles are primarlily used in retrieving stored results.

id

The Datafile id

• Type:
  int

deleted

Has the Datafile been marked for deletion

• Type:
  bool

name

Datafile name

• Type:
  str

rainbow_url

URL of the Datafile within the Indico Platform

• Type:
  str

status

Processing status of the Datafile

• Type:
  str

status_meta

Contains metadata about the status of the Datafile, such as errors

• Type:
  str

file_hash

Location of the Datafile

• Type:
  str

file_size

Size of the file, in bytes

• Type:
  int

file_type

Filetype of the Datafile

• Type:
  str

page_ids

A list of pagge ids associated with the Datafile

• Type:
  List[int]

num_pages

The number of pages in the Datafile

• Type:
  int

pages

The DatafilePages associated with the Datafile

• Type:
  List[DataFilePage]

failure_type

The type of failure associated with the Datafile, if an error was encountered

• Type:
  str