crowsetta.data.data.ExampleAnnotFile#

class crowsetta.data.data.ExampleAnnotFile(annot_path: str | bytes | PathLike | Path | _GeneratorContextManager, citation: str)[source]#

Bases: object

Class representing an example annotation file. Returned by crowsetta.data.get.

annot_path#

Path to annotation file, can be used to load. If annotation files are not been extracted to the local file system using the function crowsetta.data.extract_data_files, then crowsetta.data.get will return annot_path as a context manager that will provide a path to a temporary file.

Type:

pathlib.Path, contextlib._GeneratorContextManager

citation#

Citation for dataset from which example is taken

Type:

str

__init__(annot_path: str | bytes | PathLike | Path | _GeneratorContextManager, citation: str) None#

Method generated by attrs for class ExampleAnnotFile.

Methods

__init__(annot_path, citation)

Method generated by attrs for class ExampleAnnotFile.

Attributes

annot_path

citation