How helicalai/helical works
Overall Project Scope & Main Components
• Core Package (helical module): This is the heart of the project. It contains the main API, utility functions, and the abstraction layers for different models.
• Models Subsystem (helical/models): Under this directory you have separate subdirectories for each model (caduceus, evo_2, geneformer, helix_mrna, hyena_dna, mamba2_mrna, scgpt, uce). Each model folder typically contains configuration files, tokenizers, fine-tuning implementations, and model definitions. This clearly represents a plug‐in architecture where different bio foundation models can be selected.
• Auxiliary Utilities (helical/utils): This contains helper modules for logging, data conversion, downloading, and mapping which are used across the entire codebase.
• CI/CD and Testing (ci, .github/workflows): These directories indicate continuous integration pipelines for testing the package (unit tests in ci/tests across various models and utility modules) and automating releases.
• Documentation & External Assets: The docs, examples, and configuration files (e.g., Dockerfile, singularity.def) support deployment, usage, and developer onboarding. The examples directory shows notebooks and scripts that demonstrate using the API, and the documentation is built to guide users.
• Configuration & Build Scripts: Files like Dockerfile, entrypoint.sh, and config files (such as _config.yml, mkdocs.yml) manage deployment, documentation building, and containerization.