Reference

Release

0.2.1

Date

Feb 27, 2023

• Introduction
  • Hypergol Data Model
  • Datasets
  • Tasks
  • Pipeline
  • Testing
  • Modelling
  • Deployment
• Data Related Classes
  • BaseData - Base class for domain objects
  • Dataset - Class for storing domain objects
  • DatasetWriter - Class for writing datasets
  • DatasetReader - Class for reading datasets
  • DataChunk - Internal class for handling files
  • DatasetFactory - Convenience class to create datasets
• Pipelining Related Classes
  • Task - Class for create datasets from other datasets
  • Pipeline - Class for organising tasks and datasets together
  • Job - Class for passing information on chunks to tasks
  • JobReport - Class for passing results of a task back to the pipeline
  • Delayed - Helper class to allow passing any class to threads
• Model Creation Related Classes
  • BaseBatchProcessor - Class for handling input/output for a model
  • Classes for organising Tensorflow code
  • Classes for organising Torch code
• Miscellaneous Classes
  • Repr - Convenience class for default printing
  • NameString - Convert string between cases
  • HypergolProject - Class to manage information about the project
  • RepoManager - Helper class for storing Repository information
  • RepoData - Data class for storing Repository informations
  • Logger - Class for logging
• CLI Functions
  • create_project - Autogenerate project directories
  • create_data_model - Autogenerate domain classes
  • create_task - Autogenerate processing tasks
  • create_pipeline - Autogenerate processing pipelines
  • create_model_block - Autogenerate Tensorflow/Torch model blocks
  • create_model - Autogenerate Tensorflow/Torch models
  • list_datasets - List existing datasets
  • diff_data_model - Print differences between data model versions
  • create_old_data_model - Create an older version of the datamodel from git
• Glossary of Terms