Changelog¶
What changed in the API, the package and this site, newest first. A feature of the package has shipped when a published version carries it. Install and prepare a slide names the version these pages describe, and says when it is not published yet.
October 2026: the API¶
- A submission sends one upload id as
observation, and its kind is the upload's.observationsstill works, and is deprecated. - A job's
observationis deprecated;observation_kindcarries the same value. - A quota refusal's
Retry-Afteris the seconds until its quota resets. - The schema describes every refusal as the
Problemdocument, and names each operation's credential and scope.
September 2026: the API¶
- A job is created at
POST /v1/jobs.POST /v1/predictionsstill works, and is deprecated. - A model's card carries
output.transform, the scale a result's values are on. What you get back says where to read it.
0.1.0.dev6, October 2026: clearer messages about your key¶
- A refused
auroraomics loginnames the key still in use, where it is kept, and how to stop using it. - After the Terms change,
auroraomics doctornames the next step. - A damaged or unreadable key file is reported plainly, by name.
0.1.0.dev5, October 2026: slide scales on Python 3.11 and coarse scans¶
- On Python 3.11 and later, opening a slide reads the scale a TIFF records.
- An error carries the service's whole hint.
- Embedding tiles locally warns, and packing tiles can warn, when a coarse scan's tiles are enlarged three times or more.
0.1.0.dev4, October 2026: results for SpatialData and Seurat¶
auroraomics exportwrites results for SpatialData or Seurat, and a result opens in R.
0.1.0.dev3, October 2026: the jobs endpoint and clearer messages¶
- The API client creates jobs at
POST /v1/jobs. - Opening a slide reads the scale more slides record.
- Messages and help text name the model DeepSpot-M and say what to do next.
0.1.0.dev2, September 2026: the package reads real slides¶
- Opening a slide reads the JPEG-compressed slides most scanners write, and warns when one will be slow to read.
- Packing tiles accepts every archive form, and checks a declared scale against the slide's own.
- Embedding tiles locally is faster, with identical output.
- The command line:
doctor --tiles Ntimes a slide ofNtiles, anddoctor --allow-downloadfetches missing encoder weights. - The API client refuses, before uploading, an embeddings file the service would refuse.
0.1.0.dev1, September 2026: the package beyond the core¶
- Opening a slide: open a whole-slide image, and read its resolution from the file.
- The API client: submit a prediction, follow the job, resume an interrupted upload, download the result.
- The command line, with
--jsonon every command, and MCP tools for an agent. - Local embedding: run DeepSpot-H
over your tiles and write the
embeddingscontainer. - Gene identity: names resolve to Ensembl identifiers, and a downloaded result names its own genes offline.
- After prediction: what a model's card asks to be applied to a result file. A gene the model never measured is blank in the result, not zero.
- A new guide: Add a bulk RNA profile.
- Spatial structure: a per-gene measure of whether a gene varies with place, from a result and its coordinates.
- What the service runs: the list of models from the public cards, and a pre-flight tile-size check.
September 2026: the API opened¶
- The hosted API accepts work, and access is granted per account. Get access is the flow.
0.1.0.dev0, September 2026: the core¶
- Tile quality control, packing and checking tiles, writing results, and spatial subsampling, on your own machine.
September 2026: this documentation site¶
llms.txtandllms-full.txt: the whole site in one request.- The Python package reference.
- Explore one real slide: one open-access slide, its tissue up close, and two predictions to compare.
- The API reference.
- Limits, Errors, what you get back and retention.