API reference

API reference#

The public API of stringforge is organised around infrastructure workflows: query data, load models, persist vacua, and validate vault submissions. Physics calculations live in sibling packages such as JAXVacua.

Workflow entry points#

Goal

Start here

Query TDF/CICY catalogues without constructing physics models.

stringforge.cy_io.CYDatabase, stringforge.cy_io.TDFDatabase, stringforge.cy_io.CICYDatabase.

Load catalogue rows as JAXVacua-compatible data or models.

stringforge.lcs_database.LCSDatabaseload(), load_model(), load_batch(), iter_batch(), sample().

Work with the advanced KKLT index.

stringforge.kklt_database.KKLTDatabase — conifold-class queries, logical TDF links, model loading, and curation tags.

Store, designate, retract, or fetch vacuum solutions.

stringforge.vacua_writer.VacuaWriter.

Validate vault parquet files and rebuild vault catalogues.

stringforge.vacuavault.

Forge cluster-side production vacuum runs into a HuggingFace repo.

stringforge.vulcan.Vulcan, stringforge.vulcan.VulcanReader, stringforge.vulcan.VulcanMLView.

Module pages#