Glossary
Look up a word you hit somewhere else on this site. Each entry gives the short answer and points at the page that covers it properly.
| Term | What it means | Read more |
|---|---|---|
| Access token | The secret each instance gets at deploy when its template uses one. It is the JupyterLab token, and the key a template's web UI or API port requires. Shown on the instance's Connect tab and returned as access_token. | Ports and the Open button |
| API key | A credential prefixed shk_ that authenticates scripts. It always acts with the member role, on the one organization it was created in, and is shown to you once. | API keys |
| Auto-destroy | The automatic teardown of an organization's stopped and errored instances once its balance has been at or below ¥0 for 24 hours and is at or below −¥35. Disks are deleted with them. Running instances are only stopped, never destroyed directly. | Auto-stop and auto-destroy |
| Auto-stop | The automatic stop of an organization's running instances once its balance reaches zero. Disks survive, and storage charges continue. Where the machine supports it, the GPUs are released back to the marketplace. | Auto-stop and auto-destroy |
| Balance | The prepaid credit an organization has left. Every top-up raises it and every settlement lowers it. | Credits and the ledger |
| Base image | The image Superheat publishes for template authors to build from. It carries the SSH server and JupyterLab that the ssh and jupyter launch modes need. | Base image |
| Credits | Prepaid yuan held by an organization and spent by the second. Bought with 支付宝 (Alipay) or 微信支付 (WeChat Pay) in ¥50, ¥100 and ¥500 packs or a custom amount between ¥20 and ¥10,000. | Adding credits |
| Destroy | Ends an instance for good: the workload is removed, the disk is deleted, and the slice goes back on the marketplace. | Stop vs destroy |
| Disk | The storage attached to an instance, sized at deploy time between 10 GB and the machine's capacity. Billed per GB per hour while the instance is stopped. | Disk and storage |
| Fingerprint | The SHA256 digest that identifies an SSH key. Two keys with the same fingerprint are the same key, whatever you named them. | Add a key |
hash_id | A template's content hash over its launch recipe, and the token in a pinned share link. It is re-minted whenever the recipe changes. | Share and duplicate |
| Instance | One rental of one offer, running one template. It belongs to the organization that pays for it, not to the person who deployed it. | Instance lifecycle |
| JupyterLab | The notebook environment started by templates in jupyter launch mode, opened from the button on the instance page. | JupyterLab |
| Launch mode | How a template starts its workload: ssh, jupyter, args or vm. It decides which ports are published and whether the image has to derive from the base image. | Launch modes |
| Ledger | The append-only record of every top-up and every charge against an organization's balance. | Transactions and spend |
| Machine | A physical host in the Superheat fleet, with its own region, CPU, memory and disk. Offers are slices of one machine. | Offers and slices |
| Offer | A rentable slice of a machine at one hourly price: 1, 2, 4 or 8 GPUs of a single model. The price covers the whole slice. | Offers and slices |
| onstart | A shell script a template runs once, the first time the instance starts. It reaches the workload as the SUPERHEAT_ONSTART environment variable, never as a file. | onstart |
| Open button | The Open link on a running instance. It points at whichever port the template labels as its open-button port. | Ports |
| Organization | The account that owns everything: instances, templates, credits and keys. Members hold one of two roles, admin or member. | Organizations |
| Personal organization | The organization created for you on first sign-in and used when you have not selected another. It cannot take members. | Switching organizations |
| Region | Where a machine sits, written as a region code. The console's Region filter works by country or region; the API's region parameter accepts a region code or a country code such as CN. | Regions |
| Settlement tick | The pass that runs about once a minute, charging every metered instance for the time it has accrued and writing the result to the ledger. | How billing works |
| Slice | The set of GPUs an offer sells as one unit. One offer is rented by one instance at a time. | Offers and slices |
| SSH key | The public key you attach at deploy so you can log in to the instance. Keys belong to a user, not to an organization. | Add a key |
| Stop | Shuts the workload down but keeps the disk and your slot on the machine. GPU charges end; storage charges continue. | Stop vs destroy |
| System template | A template curated by Superheat. Everyone can see it and launch it, and nobody can edit it — duplicate it to change anything. | Templates overview |
| Template | The launch recipe: an image and tag, a launch mode, environment variables, labeled ports, an optional onstart script and machine constraints. | Templates |
| Transitional state | One of creating, starting, stopping and destroying — a change in progress. Nothing is metered and no action is accepted until it finishes. | Instance states |
| Visibility | Whether a template is system, private to your organization, or public to everyone. | Share and duplicate |