# Serialization > USearch for C Checkpoints ride the SafeGraphs interchange format, and the path's extension picks the layout: a `.safegraphs` path is one monolith of every shard, a `.safegraphs.json` path is a manifest beside one monolith per shard. Loading reads the content, never the extension, so either form loads into any shard count, part `p` loading into shard `p` modulo the shard count. ```c usearch_bytes_view_t path = {(uint8_t const*)"index.safegraphs", 16}; usearch_dense_save(&(usearch_dense_save_t) {.index = index, .executor = executor, .outcome = &outcome, .path = path}); usearch_dense_index_t copy = NULL, mapped = NULL; usearch_dense_load_ram(&(usearch_dense_load_ram_t) { .index = ©, .executor = executor, .outcome = &outcome, .path = path}); usearch_dense_view_ram(&(usearch_dense_view_ram_t) {.index = &mapped, .outcome = &outcome, .path = path}); ``` A loaded index is a mutable copy, while a viewed one serves the file in place through a memory mapping and refuses every mutating verb with `usearch_status_read_only_k`. The engine's RAM shards cannot serve a mapping yet, so it answers `usearch_dense_view_ram` with `usearch_status_unsupported_k`, while `usearch_dense_view_nvme` serves checkpoints in place today. A cancelled or failed save leaves a file without its header or parts without a manifest, which every reader rejects and the caller removes, and a cancelled or failed load creates no handle. A checkpoint's geometry and metric can be read without loading it: ```c usearch_dense_metadata_t metadata = {0}; usearch_dense_metadata_read(&(usearch_dense_metadata_read_t) { .executor = executor, .outcome = &outcome, .path = path, .metadata = &metadata}); ``` An index can also be saved into memory as one monolith of every shard, which loads into any shard count. The bytes land in an arena, so the call needs no size estimate upfront: ```c usearch_bytes_view_t monolith = {0}; usearch_dense_save_buffer(&(usearch_dense_save_buffer_t) { .index = index, .executor = executor, .outcome = &outcome, .monolith = &monolith, .arena = arena}); usearch_dense_load_ram_buffer(&(usearch_dense_load_ram_buffer_t) { .index = ©, .executor = executor, .outcome = &outcome, .buffer = monolith}); ``` `#include ` `#include ` `#include ` `#include ` `#include ` ## usearch_dense_metadata_t The geometry and metric a checkpoint froze - everything a reader learns without opening it, and nothing a reader must choose for itself. ```c struct usearch_dense_metadata_t ``` Placement is absent because a checkpoint records where it was written, never where a reader must keep it. So is `values_per_key`, which bounds a live handle's mutable state rather than anything the serialized form carries. Both remain the caller's to choose when loading, and no caller has to know which fields this call filled. - `metric` `usearch_dense_metric_t`: The metric kind the checkpoint scores with. - `quantization` `usearch_scalar_t`: The scalar type its rows are stored & quantized into. - `dimensions` `size_t`: Scalars per stored vector. - `connectivity` `size_t`: Connections per node the graph was built with. ## usearch_geospatial_metadata_t The geometry a checkpoint froze - everything a reader learns without opening it. ```c struct usearch_geospatial_metadata_t ``` - `connectivity` `size_t`: Connections per node the graph was built with. ## usearch_sequence_metadata_t The metric and geometry a checkpoint froze - everything a reader learns without opening it. ```c struct usearch_sequence_metadata_t ``` - `metric` `usearch_sequence_metric_t`: The scoring kind the checkpoint was built under. - `connectivity` `size_t`: Connections per node the graph was built with. ## usearch_shapes_metadata_t The geometry and metric a checkpoint froze - everything a reader learns without opening it. ```c struct usearch_shapes_metadata_t ``` - `metric` `usearch_shapes_metric_t`: The kind the checkpoint compares shapes with. - `quantization` `usearch_scalar_t`: The scalar type its points are stored in. - `points` `size_t`: The frozen point count, or zero for any count. - `connectivity` `size_t`: Connections per node the graph was built with. ## usearch_bytes_view_t A borrowed run of bytes and its length, never null-terminated by contract - the shape every modality's string arguments arrive in. ```c struct usearch_bytes_view_t ``` Callers holding a Rust `str`, a Go string, or a Java byte array pass their own storage without manufacturing a terminator none of them keeps. - `data` `usearch_byte_t const *`: First byte of the run; text is bytes that happen to decode. - `length` `size_t`: Bytes the run spans, with no terminator assumed or written. ## usearch_dense_load_ram Copies a checkpoint into a new, mutable index in host memory, shard by shard. ```c void usearch_dense_load_ram(usearch_dense_load_ram_t *arguments); ``` [Serialization](https://www.unum.cloud/docs/usearch/c/serialization.md) The geometry and metric come from the checkpoint's own headers, and only a non-zero `connectivity` widens the rows. Point `path` at the ``.safegraphs.json manifest, never at one of the parts it enumerates. The manifest is a small catalog that names every part and resolves each one relative to itself, so a checkpoint spread over a hundred files is opened by naming a single one. Naming a part directly is legal and loads exactly that part as a monolith, which is a fragment of the index rather than the index. Where the parts end up is the call's own memory domains, never the manifest's: part `p` is written whole on shard `p`, and shards past the placed ones open over those domains in turn, so a checkpoint of eight parts loaded naming four domains places two parts on each. A cancelled or failed load reports its status and creates no handle. - `index`: Output for the new index, written by the time the call is final. - `executor`: The executor the read fans out over, one shard per thread. - `outcome`: Output for the outcome, final once its status leaves [`usearch_status_deferred_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_deferred_k). - `completion`: Blocking, the default, or deferred. - `path`: The manifest of a sharded checkpoint, or a single ``.safegraphs monolith. - `ram`: The memory domains to place the parts on, part `p` loading into shard `p`, those past the named domains opened over them in turn. - `connectivity`: Neighbor IDs per node, at least the checkpoint's, whose wider rows keep the stored neighbors and leave the rest empty for a refine to fill; zero keeps the checkpoint's. - `values_per_key`: Upper bound on entries sharing one key, which no checkpoint records; zero is unbounded. - `progress`: The __optional__ handler, called with shards placed. Statuses: - [`usearch_status_invalid_argument_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_invalid_argument_k) An empty `path`, or a checkpoint or part path that does not parse. - [`usearch_status_malformed_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_malformed_k) The checkpoint lists no part, or a part, its header or its key column does not parse, or its connectivity or dimensions are unusable. - [`usearch_status_unknown_kind_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unknown_kind_k) An unknown quantization, a metric its quantization does not score, or a kernel a shard cannot finalize. - [`usearch_status_unsupported_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unsupported_k) A quantization this build leaves out, or a pinned class the CPU does not admit. - [`usearch_status_uninitialized_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_uninitialized_k) No memory domain to place a shard on, or the executor holds no pool workers. - [`usearch_status_config_mismatch_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_config_mismatch_k) A memory domain refusing a shard, a `connectivity` narrower than the checkpoint's, or the checkpoint's geometry, dtypes or metric differ from the shards'. - [`usearch_status_device_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_device_k) The executor is not a RAM executor. - [`usearch_status_contended_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_contended_k) Another call holds the executor, or its pool runs another dispatch. - [`usearch_status_overflow_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_overflow_k) A part passes a shard's bound. ## usearch_dense_load_vram Copies a checkpoint into a new, mutable index in device memory, with the placement rules of [`usearch_dense_load_ram`](#usearch_dense_load_ram). ```c void usearch_dense_load_vram(usearch_dense_load_vram_t *arguments); ``` [Serialization](https://www.unum.cloud/docs/usearch/c/serialization.md) - `index`: Output for the new index, written by the time the call is final. - `executor`: The executor the upload runs on, one stream per device. - `outcome`: Output for the outcome, final once its status leaves [`usearch_status_deferred_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_deferred_k). - `completion`: Blocking, the default, or deferred. - `path`: The manifest of a sharded checkpoint, or a single ``.safegraphs monolith. - `vram`: The devices to place the parts on, part `p` loading into shard `p`, those past the named devices opened over them in turn. - `values_per_key`: Upper bound on entries sharing one key, which no checkpoint records; zero is unbounded. - `progress`: The __optional__ handler, called with shards placed. Statuses: - [`usearch_status_invalid_argument_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_invalid_argument_k) An empty `path`, or a checkpoint or part path that does not parse. - [`usearch_status_malformed_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_malformed_k) The checkpoint lists no part, or a part, its header or its key column does not parse, or its connectivity or dimensions are unusable. - [`usearch_status_unknown_kind_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unknown_kind_k) An unknown quantization, a metric its quantization does not score, or a kernel a shard cannot finalize. - [`usearch_status_unsupported_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unsupported_k) A quantization this build leaves out, or devices that do not run the pinned class. - [`usearch_status_config_mismatch_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_config_mismatch_k) Devices of more than one vendor or generation, the executor driving no stream on some shard's device, or the checkpoint's geometry, dtypes or metric differing from the shards'. - [`usearch_status_device_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_device_k) An ordinal past the listing, devices this build carries no kernels for, or an executor that is not a VRAM executor. - [`usearch_status_contended_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_contended_k) Another call holds the executor. - [`usearch_status_overflow_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_overflow_k) A part passes a shard's bound. - [`usearch_status_io_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_io_k) A read of the checkpoint failed mid-load. ## usearch_dense_load_ram_buffer Copies a checkpoint from a memory buffer into a new, mutable index in host memory. ```c void usearch_dense_load_ram_buffer( usearch_dense_load_ram_buffer_t *arguments); ``` This reports and cancels like its path-taking sibling and creates no handle when stopped. That sibling reaches the same bytes through a mapping, so `buffer` needs no file behind it and a mapped file needs no copy into one. - `index`: Output for the new index, written by the time the call is final. - `executor`: The executor the copy fans out over. - `outcome`: Output for the outcome, final once its status leaves [`usearch_status_deferred_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_deferred_k). - `completion`: Blocking, the default, or deferred. - `buffer`: Source holding one serialized monolith, or the manifest of several parts leading them. - `ram`: The memory domains to place shards on; part `p` is written whole on shard `p`. - `connectivity`: Neighbor IDs per node, at least the checkpoint's, as [`usearch_dense_load_ram`](#usearch_dense_load_ram) takes it. - `values_per_key`: Upper bound on entries sharing one key, which no checkpoint records; zero is unbounded. - `progress`: The __optional__ handler, called with bytes placed. Statuses: - [`usearch_status_invalid_argument_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_invalid_argument_k) An empty `buffer`. - [`usearch_status_malformed_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_malformed_k) The manifest lists no part, or a part, its header or its key column does not parse, or its connectivity or dimensions are unusable. - [`usearch_status_unknown_kind_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unknown_kind_k) An unknown quantization, a metric its quantization does not score, or a kernel a shard cannot finalize. - [`usearch_status_unsupported_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unsupported_k) A quantization this build leaves out, or a pinned class the CPU does not admit. - [`usearch_status_uninitialized_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_uninitialized_k) No memory domain to place a shard on, or the executor holds no pool workers. - [`usearch_status_config_mismatch_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_config_mismatch_k) A memory domain refusing a shard, a `connectivity` narrower than the checkpoint's, or the checkpoint's geometry, dtypes or metric differ from the shards'. - [`usearch_status_device_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_device_k) The executor is not a RAM executor. - [`usearch_status_contended_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_contended_k) Another call holds the executor, or its pool runs another dispatch. - [`usearch_status_overflow_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_overflow_k) A part passes a shard's bound. ## usearch_dense_load_vram_buffer Copies a checkpoint from a memory buffer into a new, mutable index in device memory, reporting and cancelling like [`usearch_dense_load_ram_buffer`](#usearch_dense_load_ram_buffer). ```c void usearch_dense_load_vram_buffer( usearch_dense_load_vram_buffer_t *arguments); ``` - `index`: Output for the new index, written by the time the call is final. - `executor`: The executor the upload runs on, one stream per device. - `outcome`: Output for the outcome, final once its status leaves [`usearch_status_deferred_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_deferred_k). - `completion`: Blocking, the default, or deferred. - `buffer`: Source holding one serialized monolith, or the manifest of several parts leading them, in host or device memory; a device one is copied to the host first, so the call holds twice its bytes while it runs. - `vram`: The devices to place shards on; part `p` is written whole on shard `p`. - `values_per_key`: Upper bound on entries sharing one key, which no checkpoint records; zero is unbounded. - `progress`: The __optional__ handler, called with bytes placed. Statuses: - [`usearch_status_invalid_argument_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_invalid_argument_k) An empty `buffer`. - [`usearch_status_malformed_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_malformed_k) The manifest lists no part, or a part, its header or its key column does not parse, or its connectivity or dimensions are unusable. - [`usearch_status_unknown_kind_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unknown_kind_k) An unknown quantization, a metric its quantization does not score, or a kernel a shard cannot finalize. - [`usearch_status_unsupported_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unsupported_k) A quantization this build leaves out, or devices that do not run the pinned class. - [`usearch_status_config_mismatch_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_config_mismatch_k) Devices of more than one vendor or generation, the executor driving no stream on some shard's device, or the checkpoint's geometry, dtypes or metric differing from the shards'. - [`usearch_status_device_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_device_k) An ordinal past the listing, devices this build carries no kernels for, or an executor that is not a VRAM executor. - [`usearch_status_contended_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_contended_k) Another call holds the executor. - [`usearch_status_overflow_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_overflow_k) A part passes a shard's bound. ## usearch_dense_view_ram Serves a checkpoint in place through a memory mapping, as a read-only index. ```c void usearch_dense_view_ram(usearch_dense_view_ram_t *arguments); ``` [Serialization](https://www.unum.cloud/docs/usearch/c/serialization.md) Nothing is copied, so opening costs the headers alone and a traversal pays only for the pages it touches. Every mutating verb on the handle reports [`usearch_status_read_only_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_read_only_k), and the files must stay unmodified until the handle is freed. - `index`: Output for the new, read-only index. - `outcome`: Output for the outcome, final once its status leaves [`usearch_status_deferred_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_deferred_k). - `path`: The manifest of a sharded checkpoint, or a single ``.safegraphs monolith. Statuses: - [`usearch_status_unsupported_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unsupported_k) Always, as RAM shards cannot serve a mapping in place yet. ## usearch_dense_view_nvme Serves a checkpoint in place from NVMe drives as a read-only index, every later call reading it through its executor's engines. ```c void usearch_dense_view_nvme(usearch_dense_view_nvme_t *arguments); ``` NVMe Walks & Mergers Opening reads the headers, and with `ram` every part's key column once, on `executor's` engines, into a key table of about 11 bytes per entry: an 8-byte fingerprint and node per slot, a third more slots than entries. Every mutating verb on the handle reports [`usearch_status_read_only_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_read_only_k), and the parts must stay unmodified until the handle is freed. Without a key table, [`usearch_dense_count`](https://www.unum.cloud/docs/usearch/c/introspection.md#usearch_dense_count), [`usearch_dense_get`](https://www.unum.cloud/docs/usearch/c/retrieval-and-streaming.md#usearch_dense_get), [`usearch_dense_sample`](https://www.unum.cloud/docs/usearch/c/retrieval-and-streaming.md#usearch_dense_sample), a MaxSim and hinted walks refuse with [`usearch_status_unsupported_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unsupported_k) rather than scan every key. - `index`: Output for the new, read-only index, written by the time the call is final. - `executor`: The NVMe executor the call is ordered on; the headers come through blocking reads. - `outcome`: Output for the outcome, final once its status leaves [`usearch_status_deferred_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_deferred_k). - `completion`: Blocking, the default, or deferred. - `path`: The manifest of a sharded checkpoint, or a single ``.safegraphs monolith. - `nvme`: The devices the parts are served from; naming none serves each where its manifest points. - `ram`: The __optional__ RAM the view may hold beyond its headers, borrowed for the call: a key table on the first of `ram->memory_domains` within `ram->memory_limit`; `NULL` holds nothing per entry, so key lookups and hints refuse. Statuses: - [`usearch_status_device_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_device_k) `executor` is not an NVMe executor. - [`usearch_status_invalid_argument_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_invalid_argument_k) `ram` without an `executor` to scan the keys on. - [`usearch_status_out_of_memory_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_out_of_memory_k) The key table passes `ram->memory_limit`. - [`usearch_status_invalid_argument_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_invalid_argument_k) An empty `path`, `NULL` paths for a nonzero count, or a path that does not parse or names a base off its medium's block. - [`usearch_status_config_mismatch_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_config_mismatch_k) Parts disagreeing with each other, with the scalar or with `nvme`. - [`usearch_status_unsupported_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unsupported_k) A transport identifier in a build without SPDK, a quantization this build leaves out, or a pinned class the CPU does not admit. - [`usearch_status_malformed_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_malformed_k) The manifest names no part, or a manifest or header does not parse. - [`usearch_status_unknown_kind_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unknown_kind_k) An unknown quantization, a metric its quantization does not score, or a kernel the stored scalar's kits cannot finalize. ## usearch_dense_save Saves a mutable index under `path` in the layout its shard count picks - one monolith, or a manifest beside its shards; concurrent readers keep searching throughout. ```c void usearch_dense_save(usearch_dense_save_t *arguments); ``` [Serialization](https://www.unum.cloud/docs/usearch/c/serialization.md) A cancelled or failed monolith save leaves a file without its header, which every reader rejects; a cancelled manifest save leaves the parts it already wrote and no manifest, so the checkpoint reads as absent rather than half-valid. Those leftovers are the caller's to remove. - `index`: The handle to be written. - `executor`: The executor the write fans out over, one shard per thread or stream. - `outcome`: Output for the outcome, final once its status leaves [`usearch_status_deferred_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_deferred_k). - `completion`: Blocking, the default, or deferred. - `path`: Destination path: the monolith of a lone shard, or the manifest beside the parts of many. - `progress`: The __optional__ handler, called with shards written. Statuses: - [`usearch_status_contended_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_contended_k) A RAM save meeting an insertion in flight or one publishing under it, or a VRAM save meeting an insertion, refinement, absorption or another save in flight; an insertion arriving while a VRAM save runs is refused the same way. ## usearch_*_save_buffer Saves a mutable index into `arena:` one monolith for a handle of one shard, or a manifest leading one part per shard. ```c void usearch_dense_save_buffer(usearch_dense_save_buffer_t *arguments); ``` - `usearch_dense_save_buffer`: index `usearch_dense_index_t` - `usearch_geospatial_save_buffer`: index `usearch_geospatial_index_t` - `usearch_sequence_save_buffer`: index `usearch_sequence_index_t` - `usearch_shapes_save_buffer`: index `usearch_shapes_index_t` [Serialization](https://www.unum.cloud/docs/usearch/c/serialization.md) A lone shard's monolith is the same bytes the path-taking sibling writes into its own mapping. Several shards write the manifest first, listing each part by its offset inside the buffer, then every part on the header's alignment, each with its shard's own node IDs, so a load opens one shard per part again. A caller who needs the bytes in memory it already owns, such as a mapped file, saves to a path instead. A VRAM handle's checkpoint is written in device memory, written on the host first, so the call holds twice its bytes while it runs. Writing to memory is not writing quickly. A terabyte checkpoint on a handful of cores runs for minutes, so this reports and cancels like its path-taking sibling, and a cancelled call leaves `monolith->data` `NULL`. Demands a mutation-free window; concurrent readers keep searching throughout. A lone shard's monolith is the same bytes [`usearch_geospatial_save`](#usearch_geospatial_save) writes. Several shards write the manifest first, listing each part by its offset inside the buffer, then every part on the header's alignment, each with its shard's own node IDs, so a load opens one shard per part again. A cancelled call leaves `monolith->data` `NULL`. Demands a mutation-free window; concurrent readers keep searching throughout. A lone shard's monolith is the same bytes [`usearch_sequence_save`](#usearch_sequence_save) writes. Several shards write the manifest first, listing each part by its offset inside the buffer, then every part on the header's alignment, each with its shard's own node IDs, so a load opens one shard per part again. A cancelled call leaves `monolith->data` `NULL`. Demands a mutation-free window; concurrent readers keep searching throughout. A lone shard's monolith is the same bytes [`usearch_shapes_save`](#usearch_shapes_save) writes. Several shards write the manifest first, listing each part by its offset inside the buffer, then every part on the header's alignment, each with its shard's own node IDs, so a load opens one shard per part again. A cancelled call leaves `monolith->data` `NULL`. - `index`: The handle to be written. - `executor`: The executor to fan out over; its kind must match the residency. - `outcome`: Output for the outcome, final once its status leaves [`usearch_status_deferred_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_deferred_k). - `completion`: Blocking, the default, or deferred. - `monolith`: Output for the checkpoint's bytes and length, inside `arena`. - `arena`: Memory for `monolith`, rewound by the call. - `progress`: The __optional__ handler, called with bytes written. Statuses: - [`usearch_status_invalid_argument_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_invalid_argument_k) A `NULL` `arena`. - [`usearch_status_device_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_device_k) An arena or an executor on another residency or device. - [`usearch_status_contended_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_contended_k) The arena serves another call, another call holds the executor or its pool, a dispensed batch has yet to publish, or a call, batch, load or plan holds the handle. - [`usearch_status_unsupported_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unsupported_k) The handle is an NVMe view, which already is its checkpoint. - [`usearch_status_uninitialized_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_uninitialized_k) No shard is placed, or the executor holds no pool workers. - [`usearch_status_unknown_kind_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unknown_kind_k) The stored scalar has no interchange dtype. - [`usearch_status_config_mismatch_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_config_mismatch_k) The executor drives no stream on some VRAM shard's device. Statuses: - [`usearch_status_invalid_argument_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_invalid_argument_k) A `NULL` `arena`. - [`usearch_status_device_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_device_k) An arena or an executor on another residency or device. - [`usearch_status_contended_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_contended_k) The arena serves another call, another call holds the executor or its pool, a dispensed batch has yet to publish, or a call, batch, load or plan holds the handle. - [`usearch_status_unsupported_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unsupported_k) The handle is an NVMe view, which already is its checkpoint, or lives on a GPU, which writes no checkpoint into memory yet. - [`usearch_status_uninitialized_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_uninitialized_k) No shard is live, or the executor holds no pool workers. - [`usearch_status_config_mismatch_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_config_mismatch_k) A stored value disagrees with the shape its column records. - [`usearch_status_out_of_memory_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_out_of_memory_k) The arena cannot grow to the checkpoint's length. ## usearch_*_metadata_read Reads a checkpoint's geometry & metric without loading it. ```c void usearch_dense_metadata_read( usearch_dense_metadata_read_t *arguments); ``` - `usearch_dense_metadata_read`: metadata `usearch_dense_metadata_t` - `usearch_shapes_metadata_read`: metadata `usearch_shapes_metadata_t` A manifest answers from its summary and its first part's header, so the cost does not grow with the index. - `executor`: The executor the read runs on. - `outcome`: Output for the outcome, final once its status leaves [`usearch_status_deferred_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_deferred_k). - `completion`: Blocking, the default, or deferred. - `path`: The manifest of a sharded checkpoint, or a single ``.safegraphs monolith. - `metadata`: Output for every field the checkpoint froze. Statuses: - [`usearch_status_invalid_argument_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_invalid_argument_k) An empty `path`, or a path that does not parse. - [`usearch_status_malformed_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_malformed_k) The file is empty, or its manifest or header does not parse. Statuses: - [`usearch_status_invalid_argument_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_invalid_argument_k) The checkpoint or a part path does not parse. - [`usearch_status_malformed_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_malformed_k) The checkpoint or a part is empty, its manifest lists no part, or a header does not parse or spans more bytes than its part. ## usearch_dense_metadata_read_buffer Reads geometry & metric from a serialized checkpoint buffer. ```c void usearch_dense_metadata_read_buffer( usearch_dense_metadata_read_buffer_t *arguments); ``` - `executor`: The executor the read runs on. - `outcome`: Output for the outcome, final once its status leaves [`usearch_status_deferred_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_deferred_k). - `completion`: Blocking, the default, or deferred. - `buffer`: Source holding one serialized monolith, or the manifest of several parts leading them. - `metadata`: Output for every field the checkpoint froze. Statuses: - [`usearch_status_invalid_argument_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_invalid_argument_k) An empty `buffer`. - [`usearch_status_malformed_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_malformed_k) The manifest or the header does not parse. ## usearch_geospatial_load_ram Copies a checkpoint into a new, mutable index in host memory, its geometry read from the checkpoint's own headers. ```c void usearch_geospatial_load_ram( usearch_geospatial_load_ram_t *arguments); ``` Where the parts end up is the call's own memory domains, never the manifest's: part `p` is written whole on shard `p`, beside any placed shards the parts leave empty, and the shards past the placed ones open over those domains in turn. - `index`: Output for the new index, written by the time the call is final. - `executor`: The executor the read fans out over, one shard per thread. - `outcome`: Output for the outcome, final once its status leaves [`usearch_status_deferred_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_deferred_k). - `completion`: Blocking, the default, or deferred. - `path`: Checkpoint path - a monolith, or a manifest naming many. - `ram`: The memory domains to place the parts on. - `values_per_key`: Observations one key may hold at most, which no checkpoint records; zero is unbounded. - `terrain`: The __optional__ terrain lines of sight are tested over, which no checkpoint carries. - `progress`: The __optional__ handler, called with parts placed and their count. Statuses: - [`usearch_status_invalid_argument_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_invalid_argument_k) An empty `path`, a checkpoint or part path that does not parse, or a terrain both borrowing `heights` and naming a `callback`. - [`usearch_status_malformed_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_malformed_k) The checkpoint lists no part, or a part, its header, columns or sums do not parse. - [`usearch_status_unsupported_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unsupported_k) A terrain `path`, or a pinned class the CPU does not admit. - [`usearch_status_uninitialized_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_uninitialized_k) The executor holds no pool workers. - [`usearch_status_config_mismatch_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_config_mismatch_k) A terrain whose row or column step is not positive, or the checkpoint's columns differ from the shards' in dtype, shape or key width. - [`usearch_status_device_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_device_k) The executor is not a RAM executor. - [`usearch_status_contended_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_contended_k) Another call holds the executor, or its pool runs another dispatch. - [`usearch_status_overflow_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_overflow_k) A part passes a shard's bound or its key multimap. ## usearch_geospatial_load_ram_buffer Copies a checkpoint from a memory buffer into a new, mutable index in host memory. ```c void usearch_geospatial_load_ram_buffer( usearch_geospatial_load_ram_buffer_t *arguments); ``` This places, reports and cancels like [`usearch_geospatial_load_ram`](#usearch_geospatial_load_ram), which reaches the same bytes through a mapping, so `buffer` needs no file behind it, and a mapped file no copy. - `index`: Output for the new index, written by the time the call is final. - `executor`: The executor the read fans out over, one shard per thread. - `outcome`: Output for the outcome, final once its status leaves [`usearch_status_deferred_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_deferred_k). - `completion`: Blocking, the default, or deferred. - `buffer`: Source holding one serialized monolith, or the manifest of several parts leading them. - `ram`: The memory domains to place the parts on. - `values_per_key`: Observations one key may hold at most, which no checkpoint records; zero is unbounded. - `terrain`: The __optional__ terrain lines of sight are tested over, which no checkpoint carries. - `progress`: The __optional__ handler, called with parts placed and their count. Statuses: - [`usearch_status_invalid_argument_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_invalid_argument_k) An empty `buffer`, or a terrain both borrowing `heights` and naming a `callback`. - [`usearch_status_malformed_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_malformed_k) The manifest lists no part, or a part, its header, columns or sums do not parse. - [`usearch_status_unsupported_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unsupported_k) A terrain `path`, or a pinned class the CPU does not admit. - [`usearch_status_uninitialized_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_uninitialized_k) The executor holds no pool workers. - [`usearch_status_config_mismatch_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_config_mismatch_k) A terrain whose row or column step is not positive, or the checkpoint's columns differ from the shards' in dtype, shape or key width. - [`usearch_status_device_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_device_k) The executor is not a RAM executor. - [`usearch_status_contended_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_contended_k) Another call holds the executor, or its pool runs another dispatch. - [`usearch_status_overflow_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_overflow_k) A part passes a shard's bound or its key multimap. ## usearch_geospatial_load_vram Copies a checkpoint into a new, mutable index in device memory, with the placement rules of [`usearch_geospatial_load_ram`](#usearch_geospatial_load_ram). ```c void usearch_geospatial_load_vram( usearch_geospatial_load_vram_t *arguments); ``` - `index`: Output for the new index, written by the time the call is final. - `executor`: The executor the upload runs on, one stream per device. - `outcome`: Output for the outcome, final once its status leaves [`usearch_status_deferred_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_deferred_k). - `completion`: Blocking, the default, or deferred. - `path`: Checkpoint path - a monolith, or a manifest naming many. - `vram`: The devices to place the parts on. - `values_per_key`: Observations one key may hold at most, which no checkpoint records; zero is unbounded. - `terrain`: The __optional__ terrain lines of sight are tested over, which no checkpoint carries. - `progress`: The __optional__ handler, called with parts placed and their count. Statuses: - [`usearch_status_invalid_argument_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_invalid_argument_k) An empty `path`, a checkpoint or part path that does not parse, or a terrain both borrowing `heights` and naming a `callback`. - [`usearch_status_malformed_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_malformed_k) The checkpoint lists no part, or a part, its header, columns or sums do not parse. - [`usearch_status_unsupported_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unsupported_k) A terrain `path` or `callback`, a `values_per_key` bound, or devices that do not run the pinned class. - [`usearch_status_config_mismatch_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_config_mismatch_k) Devices of two classes, a terrain whose row or column step is not positive, the executor driving no stream on some shard's device, or the checkpoint's columns differing from the shards' in dtype, shape or key width. - [`usearch_status_device_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_device_k) An ordinal past the listing, devices this build carries no kernels for, a build without GPU kernels, or an executor that is not a VRAM executor. - [`usearch_status_contended_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_contended_k) Another call holds the executor. - [`usearch_status_overflow_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_overflow_k) A part passes a shard's bound or its key multimap. - [`usearch_status_io_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_io_k) A read of the checkpoint failed mid-load. ## usearch_geospatial_load_vram_buffer Copies a checkpoint from a memory buffer into a new, mutable index in device memory, reporting and cancelling like [`usearch_geospatial_load_vram`](#usearch_geospatial_load_vram). ```c void usearch_geospatial_load_vram_buffer( usearch_geospatial_load_vram_buffer_t *arguments); ``` - `index`: Output for the new index, written by the time the call is final. - `executor`: The executor the upload runs on, one stream per device. - `outcome`: Output for the outcome, final once its status leaves [`usearch_status_deferred_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_deferred_k). - `completion`: Blocking, the default, or deferred. - `buffer`: Source holding one serialized monolith, or the manifest of several parts leading them, in host memory. - `vram`: The devices to place the parts on. - `values_per_key`: Observations one key may hold at most, which no checkpoint records; zero is unbounded. - `terrain`: The __optional__ terrain lines of sight are tested over, which no checkpoint carries. - `progress`: The __optional__ handler, called with parts placed and their count. Statuses: - [`usearch_status_invalid_argument_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_invalid_argument_k) An empty `buffer`, or a terrain both borrowing `heights` and naming a `callback`. - [`usearch_status_malformed_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_malformed_k) The manifest lists no part, or a part, its header, columns or sums do not parse. - [`usearch_status_unsupported_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unsupported_k) A `buffer` in device memory, a terrain `path` or `callback`, a `values_per_key` bound, or devices that do not run the pinned class. - [`usearch_status_config_mismatch_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_config_mismatch_k) Devices of two classes, a terrain whose row or column step is not positive, the executor driving no stream on some shard's device, or the checkpoint's columns differing from the shards' in dtype, shape or key width. - [`usearch_status_device_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_device_k) An ordinal past the listing, devices this build carries no kernels for, a build without GPU kernels, or an executor that is not a VRAM executor. - [`usearch_status_contended_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_contended_k) Another call holds the executor. - [`usearch_status_overflow_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_overflow_k) A part passes a shard's bound or its key multimap. ## usearch_geospatial_view_ram Serves a checkpoint in place through a memory mapping, as a read-only index whose mutating verbs report [`usearch_status_read_only_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_read_only_k). ```c void usearch_geospatial_view_ram( usearch_geospatial_view_ram_t *arguments); ``` - `index`: Output for the new, read-only index. - `outcome`: Output for the outcome, final once its status leaves [`usearch_status_deferred_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_deferred_k). - `path`: Checkpoint path - a monolith, or a manifest naming many. - `terrain`: The __optional__ terrain lines of sight are tested over, which no checkpoint carries. - `ram`: The class to dispatch as; a view reads its shards from the checkpoint, so only `[usearch_ram_options_t::cpu_class](https://www.unum.cloud/docs/usearch/c/residency.md#usearch_ram_options_t)` is read. Statuses: - [`usearch_status_invalid_argument_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_invalid_argument_k) An empty `path`, a checkpoint or part path that does not parse, or a terrain both borrowing `heights` and naming a `callback`. - [`usearch_status_malformed_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_malformed_k) The checkpoint lists no part, or a part or its header does not parse. - [`usearch_status_config_mismatch_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_config_mismatch_k) A terrain whose row or column step is not positive. - [`usearch_status_unsupported_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unsupported_k) Every other checkpoint, as RAM shards cannot serve a mapping in place yet. ## usearch_geospatial_view_nvme Serves a checkpoint in place from NVMe drives as a read-only index, every later call reading it through its executor's engines. ```c void usearch_geospatial_view_nvme( usearch_geospatial_view_nvme_t *arguments); ``` Opening reads the headers alone. Every mutating verb on the handle reports [`usearch_status_read_only_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_read_only_k), and the parts must stay unmodified until the handle is freed. - `index`: Output for the new, read-only index, written by the time the call is final. - `executor`: The NVMe executor the call is ordered on; the headers come through blocking reads. - `outcome`: Output for the outcome, final once its status leaves [`usearch_status_deferred_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_deferred_k). - `completion`: Blocking, the default, or deferred. - `path`: Checkpoint path - a monolith, or a manifest naming many. - `nvme`: The devices the parts are served from; naming none serves each where its manifest points. - `terrain`: The __optional__ terrain lines of sight are tested over, which no checkpoint carries. Statuses: - [`usearch_status_device_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_device_k) `executor` is not an NVMe executor. - [`usearch_status_invalid_argument_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_invalid_argument_k) An empty `path`, `NULL` paths for a nonzero count, a path that does not parse or names a base off its medium's block, or a terrain both borrowing `heights` and naming a `callback`. - [`usearch_status_malformed_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_malformed_k) The manifest names no part, or a manifest, header or row directory does not parse. - [`usearch_status_config_mismatch_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_config_mismatch_k) Parts disagreeing with this index's values, keys, node IDs or metric, or with `nvme`, or a terrain whose row or column step is not positive. - [`usearch_status_unsupported_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unsupported_k) A terrain `path`, or a pinned class the CPU does not admit. - [`usearch_status_uninitialized_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_uninitialized_k) The executor holds no threads or pool workers. - [`usearch_status_contended_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_contended_k) Another call holds the executor, or its pool runs another dispatch. ## usearch_*_save Saves a mutable index under `path`. ```c void usearch_geospatial_save(usearch_geospatial_save_t *arguments); ``` - `usearch_geospatial_save`: index `usearch_geospatial_index_t` - `usearch_sequence_save`: index `usearch_sequence_index_t` - `usearch_shapes_save`: index `usearch_shapes_index_t` Demands a mutation-free window; concurrent readers keep searching throughout. The shard count picks the layout: one shard writes one monolith at `path`, and several write the manifest at `path` beside one part per shard, each with its shard's own node IDs. A cancelled save leaves the parts it already wrote and no manifest referencing them, so the checkpoint reads as absent rather than half-valid. Those leftovers are the caller's to remove. - `index`: The handle to be written. - `executor`: The executor the write fans out over, one shard per thread or stream. - `outcome`: Output for the outcome, final once its status leaves [`usearch_status_deferred_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_deferred_k). - `completion`: Blocking, the default, or deferred. - `path`: Destination path: the monolith of a lone shard, or the manifest beside the parts of many. - `progress`: The __optional__ handler, called with parts written and their count. Statuses: - [`usearch_status_invalid_argument_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_invalid_argument_k) An empty `path`, or a part or manifest path that does not parse. - [`usearch_status_device_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_device_k) The executor's kind does not match the residency. - [`usearch_status_unsupported_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unsupported_k) The handle is an NVMe view, which already is its checkpoint. - [`usearch_status_contended_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_contended_k) Another call holds the executor or its pool, a dispensed batch has yet to publish, or a call, batch, load or plan holds the handle. - [`usearch_status_uninitialized_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_uninitialized_k) The executor holds no pool workers. - [`usearch_status_config_mismatch_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_config_mismatch_k) The executor drives no stream on some VRAM shard's device. - [`usearch_status_overflow_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_overflow_k) `path` names a device that ends before a part or the manifest. ## usearch_geospatial_metadata_read Reads a checkpoint's geometry without loading it. ```c void usearch_geospatial_metadata_read( usearch_geospatial_metadata_read_t *arguments); ``` - `executor`: The executor the read runs on. - `outcome`: Output for the outcome, final once its status leaves [`usearch_status_deferred_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_deferred_k). - `completion`: Blocking, the default, or deferred. - `path`: Checkpoint path - a monolith, or a manifest naming many. - `metadata`: Output for every field the checkpoint froze. Statuses: - [`usearch_status_invalid_argument_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_invalid_argument_k) The checkpoint or a part path does not parse. - [`usearch_status_malformed_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_malformed_k) The checkpoint or a part is empty, its manifest lists no part, or a header does not parse or spans more bytes than its part. ## usearch_geospatial_metadata_read_buffer Reads the fields a checkpoint in a memory buffer froze without loading it, as [`usearch_geospatial_metadata_read`](#usearch_geospatial_metadata_read) reads them from a path. ```c void usearch_geospatial_metadata_read_buffer( usearch_geospatial_metadata_read_buffer_t *arguments); ``` - `executor`: The executor the read runs on. - `outcome`: Output for the outcome, final once its status leaves [`usearch_status_deferred_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_deferred_k). - `completion`: Blocking, the default, or deferred. - `buffer`: Source holding one serialized monolith, or the manifest of several parts leading them. - `metadata`: Output for every field the checkpoint froze. Statuses: - [`usearch_status_invalid_argument_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_invalid_argument_k) An empty `buffer`. - [`usearch_status_malformed_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_malformed_k) The manifest lists no part, or a header does not parse or spans more bytes than its part. ## usearch_sequence_load_ram Copies a checkpoint into a new, mutable index in host memory. ```c void usearch_sequence_load_ram(usearch_sequence_load_ram_t *arguments); ``` Where the parts end up is the call's own memory domains, never the manifest's: part `p` is written whole on shard `p`, beside any placed shards the parts leave empty, and the shards past the placed ones open over those domains in turn. - `index`: Output for the new index, written by the time the call is final. - `executor`: The executor the read fans out over, one shard per thread. - `outcome`: Output for the outcome, final once its status leaves [`usearch_status_deferred_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_deferred_k). - `completion`: Blocking, the default, or deferred. - `path`: Checkpoint path - a monolith, or a manifest naming many. - `ram`: The memory domains to place the parts on. - `values_per_key`: Upper bound on entries sharing one key, which no checkpoint records; zero is unbounded. - `weights`: The weights an alignment checkpoint was built with; `NULL` for the Levenshtein kinds. - `progress`: The __optional__ handler, called with parts placed and their count. Statuses: - [`usearch_status_invalid_argument_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_invalid_argument_k) An empty `path`, a checkpoint or part path that does not parse, or `weights` without a substitution matrix. - [`usearch_status_malformed_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_malformed_k) The checkpoint lists no part, or a part, its header, columns, sums or recorded costs do not parse. - [`usearch_status_unknown_kind_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unknown_kind_k) A checkpoint of an unknown metric. - [`usearch_status_unsupported_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unsupported_k) A pinned class the CPU does not admit. - [`usearch_status_uninitialized_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_uninitialized_k) The executor holds no pool workers. - [`usearch_status_config_mismatch_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_config_mismatch_k) `weights` for a checkpoint of another kind than Needleman-Wunsch or folding into more than 32 classes, a negative gap or a pair above its mean self-score, a Needleman-Wunsch checkpoint recording no costs and given no weights, or the checkpoint's columns differing from the shards' in dtype, shape or key width. - [`usearch_status_device_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_device_k) The executor is not a RAM executor. - [`usearch_status_contended_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_contended_k) Another call holds the executor, or its pool runs another dispatch. - [`usearch_status_overflow_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_overflow_k) A part passes a shard's bound or its key multimap. ## usearch_sequence_load_ram_buffer Copies a checkpoint from a memory buffer into a new, mutable index in host memory. ```c void usearch_sequence_load_ram_buffer( usearch_sequence_load_ram_buffer_t *arguments); ``` This places, reports and cancels like [`usearch_sequence_load_ram`](#usearch_sequence_load_ram), which reaches the same bytes through a mapping, so `buffer` needs no file behind it, and a mapped file no copy. - `index`: Output for the new index, written by the time the call is final. - `executor`: The executor the read fans out over, one shard per thread. - `outcome`: Output for the outcome, final once its status leaves [`usearch_status_deferred_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_deferred_k). - `completion`: Blocking, the default, or deferred. - `buffer`: Source holding one serialized monolith, or the manifest of several parts leading them. - `ram`: The memory domains to place the parts on. - `values_per_key`: Upper bound on entries sharing one key, which no checkpoint records; zero is unbounded. - `weights`: The weights an alignment checkpoint was built with; `NULL` for the Levenshtein kinds. - `progress`: The __optional__ handler, called with parts placed and their count. Statuses: - [`usearch_status_invalid_argument_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_invalid_argument_k) An empty `buffer`, or `weights` without a substitution matrix. - [`usearch_status_malformed_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_malformed_k) The manifest lists no part, or a part, its header, columns, sums or recorded costs do not parse. - [`usearch_status_unknown_kind_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unknown_kind_k) A checkpoint of an unknown metric. - [`usearch_status_unsupported_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unsupported_k) A pinned class the CPU does not admit. - [`usearch_status_uninitialized_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_uninitialized_k) The executor holds no pool workers. - [`usearch_status_config_mismatch_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_config_mismatch_k) `weights` or recorded costs [`usearch_sequence_load_ram`](#usearch_sequence_load_ram) refuses for the same reasons, or the checkpoint's columns differing from the shards' in dtype, shape or key width. - [`usearch_status_device_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_device_k) The executor is not a RAM executor. - [`usearch_status_contended_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_contended_k) Another call holds the executor, or its pool runs another dispatch. - [`usearch_status_overflow_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_overflow_k) A part passes a shard's bound or its key multimap. ## usearch_sequence_load_vram Copies a checkpoint into a new, mutable index in device memory, with the placement rules of [`usearch_sequence_load_ram`](#usearch_sequence_load_ram). ```c void usearch_sequence_load_vram( usearch_sequence_load_vram_t *arguments); ``` - `index`: Output for the new index, written by the time the call is final. - `executor`: The executor the upload runs on, one stream per device. - `outcome`: Output for the outcome, final once its status leaves [`usearch_status_deferred_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_deferred_k). - `completion`: Blocking, the default, or deferred. - `path`: Checkpoint path - a monolith, or a manifest naming many. - `vram`: The devices to place the parts on. - `values_per_key`: Zero alone: a GPU index keeps no key lookup, so it bounds no key's entries and refuses any bound it is given. - `weights`: The weights an alignment checkpoint was built with; `NULL` for the Levenshtein kinds. - `progress`: The __optional__ handler, called with parts placed and their count. Statuses: - [`usearch_status_invalid_argument_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_invalid_argument_k) An empty `path`, a checkpoint or part path that does not parse, or `weights` without a substitution matrix. - [`usearch_status_malformed_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_malformed_k) The checkpoint lists no part, or a part, its header, columns, sums or recorded costs do not parse. - [`usearch_status_unknown_kind_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unknown_kind_k) A checkpoint of an unknown metric. - [`usearch_status_unsupported_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unsupported_k) A `values_per_key` bound, or devices that do not run the pinned class. - [`usearch_status_config_mismatch_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_config_mismatch_k) Devices of two classes, `weights` for a checkpoint of another kind than Needleman-Wunsch or folding into more than 32 classes, a negative gap or a pair above its mean self-score, a Needleman-Wunsch checkpoint recording no costs and given no weights, the executor driving no stream on some shard's device, or the checkpoint's columns differing from the shards' in dtype, shape or key width. - [`usearch_status_device_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_device_k) An ordinal past the listing, devices this build carries no kernels for, a build without GPU kernels, or an executor that is not a VRAM executor. - [`usearch_status_contended_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_contended_k) Another call holds the executor. - [`usearch_status_overflow_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_overflow_k) A part passes a shard's bound or its key multimap. - [`usearch_status_io_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_io_k) A read of the checkpoint failed mid-load. ## usearch_sequence_load_vram_buffer Copies a checkpoint from a memory buffer into a new, mutable index in device memory, reporting and cancelling like [`usearch_sequence_load_vram`](#usearch_sequence_load_vram). ```c void usearch_sequence_load_vram_buffer( usearch_sequence_load_vram_buffer_t *arguments); ``` - `index`: Output for the new index, written by the time the call is final. - `executor`: The executor the upload runs on, one stream per device. - `outcome`: Output for the outcome, final once its status leaves [`usearch_status_deferred_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_deferred_k). - `completion`: Blocking, the default, or deferred. - `buffer`: Source holding one serialized monolith, or the manifest of several parts leading them, in host memory. - `vram`: The devices to place the parts on. - `values_per_key`: Zero alone: a GPU index keeps no key lookup, so it bounds no key's entries and refuses any bound it is given. - `weights`: The weights an alignment checkpoint was built with; `NULL` for the Levenshtein kinds. - `progress`: The __optional__ handler, called with parts placed and their count. Statuses: - [`usearch_status_invalid_argument_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_invalid_argument_k) An empty `buffer`, or `weights` without a substitution matrix. - [`usearch_status_malformed_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_malformed_k) The manifest lists no part, or a part, its header, columns, sums or recorded costs do not parse. - [`usearch_status_unknown_kind_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unknown_kind_k) A checkpoint of an unknown metric. - [`usearch_status_unsupported_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unsupported_k) A `buffer` in device memory, a `values_per_key` bound, or devices that do not run the pinned class. - [`usearch_status_config_mismatch_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_config_mismatch_k) Devices of two classes, `weights` for a checkpoint of another kind than Needleman-Wunsch or folding into more than 32 classes, a negative gap or a pair above its mean self-score, a Needleman-Wunsch checkpoint recording no costs and given no weights, the executor driving no stream on some shard's device, or the checkpoint's columns differing from the shards' in dtype, shape or key width. - [`usearch_status_device_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_device_k) An ordinal past the listing, devices this build carries no kernels for, a build without GPU kernels, or an executor that is not a VRAM executor. - [`usearch_status_contended_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_contended_k) Another call holds the executor. - [`usearch_status_overflow_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_overflow_k) A part passes a shard's bound or its key multimap. ## usearch_sequence_view_ram Serves a checkpoint in place through a memory mapping, as a read-only index whose mutating verbs report [`usearch_status_read_only_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_read_only_k). ```c void usearch_sequence_view_ram(usearch_sequence_view_ram_t *arguments); ``` - `index`: Output for the new, read-only index. - `outcome`: Output for the outcome, final once its status leaves [`usearch_status_deferred_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_deferred_k). - `path`: Checkpoint path - a monolith, or a manifest naming many. - `weights`: The weights an alignment checkpoint was built with; `NULL` for the Levenshtein kinds. - `ram`: The class to dispatch as; a view reads its shards from the checkpoint, so only `[usearch_ram_options_t::cpu_class](https://www.unum.cloud/docs/usearch/c/residency.md#usearch_ram_options_t)` is read. Statuses: - [`usearch_status_invalid_argument_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_invalid_argument_k) An empty `path`, a checkpoint or part path that does not parse, or `weights` without a substitution matrix. - [`usearch_status_malformed_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_malformed_k) The checkpoint lists no part, or a part, its header or its recorded costs do not parse. - [`usearch_status_unknown_kind_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unknown_kind_k) A checkpoint of an unknown metric. - [`usearch_status_config_mismatch_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_config_mismatch_k) `weights` for a checkpoint of another kind than Needleman-Wunsch or folding into more than 32 classes, a negative gap or a pair above its mean self-score, or a Needleman-Wunsch checkpoint recording no costs and given no weights. - [`usearch_status_unsupported_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unsupported_k) Every other checkpoint, as RAM shards cannot serve a mapping in place yet. ## usearch_sequence_view_nvme Serves a checkpoint in place from NVMe drives as a read-only index, every later call reading it through its executor's engines. ```c void usearch_sequence_view_nvme( usearch_sequence_view_nvme_t *arguments); ``` Opening reads the headers alone. Every mutating verb on the handle reports [`usearch_status_read_only_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_read_only_k), and the parts must stay unmodified until the handle is freed. - `index`: Output for the new, read-only index, written by the time the call is final. - `executor`: The NVMe executor the call is ordered on; the headers come through blocking reads. - `outcome`: Output for the outcome, final once its status leaves [`usearch_status_deferred_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_deferred_k). - `completion`: Blocking, the default, or deferred. - `path`: Checkpoint path - a monolith, or a manifest naming many. - `nvme`: The devices the parts are served from; naming none serves each where its manifest points. - `weights`: The weights an alignment checkpoint was built with; `NULL` for the Levenshtein kinds. Statuses: - [`usearch_status_device_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_device_k) `executor` is not an NVMe executor. - [`usearch_status_invalid_argument_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_invalid_argument_k) An empty `path`, `NULL` paths for a nonzero count, a path that does not parse or names a base off its medium's block, or `weights` without a substitution matrix. - [`usearch_status_malformed_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_malformed_k) The manifest names no part, or a manifest, header, row directory or the recorded costs do not parse. - [`usearch_status_unknown_kind_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unknown_kind_k) A checkpoint of an unknown metric. - [`usearch_status_config_mismatch_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_config_mismatch_k) Parts disagreeing with this index's values, keys, node IDs or metric, or with `nvme`, `weights` for a checkpoint of another kind than Needleman-Wunsch or folding into more than 32 classes, a negative gap or a pair above its mean self-score, or a Needleman-Wunsch checkpoint recording no costs and given no weights. - [`usearch_status_unsupported_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unsupported_k) A pinned class the CPU does not admit. - [`usearch_status_uninitialized_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_uninitialized_k) The executor holds no threads or pool workers. - [`usearch_status_contended_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_contended_k) Another call holds the executor, or its pool runs another dispatch. ## usearch_sequence_metadata_read Reads a checkpoint's metric & geometry without loading it. ```c void usearch_sequence_metadata_read( usearch_sequence_metadata_read_t *arguments); ``` - `executor`: The executor the read runs on. - `outcome`: Output for the outcome, final once its status leaves [`usearch_status_deferred_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_deferred_k). - `completion`: Blocking, the default, or deferred. - `path`: Checkpoint path - a monolith, or a manifest naming many. - `metadata`: Output for every field the checkpoint froze. Statuses: - [`usearch_status_invalid_argument_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_invalid_argument_k) The checkpoint or a part path does not parse. - [`usearch_status_malformed_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_malformed_k) The checkpoint or a part is empty, its manifest lists no part, or a header does not parse or spans more bytes than its part. ## usearch_sequence_metadata_read_buffer Reads the fields a checkpoint in a memory buffer froze without loading it, as [`usearch_sequence_metadata_read`](#usearch_sequence_metadata_read) reads them from a path. ```c void usearch_sequence_metadata_read_buffer( usearch_sequence_metadata_read_buffer_t *arguments); ``` - `executor`: The executor the read runs on. - `outcome`: Output for the outcome, final once its status leaves [`usearch_status_deferred_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_deferred_k). - `completion`: Blocking, the default, or deferred. - `buffer`: Source holding one serialized monolith, or the manifest of several parts leading them. - `metadata`: Output for every field the checkpoint froze. Statuses: - [`usearch_status_invalid_argument_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_invalid_argument_k) An empty `buffer`. - [`usearch_status_malformed_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_malformed_k) The manifest lists no part, or a header does not parse or spans more bytes than its part. ## usearch_shapes_load_ram Copies a checkpoint into a new, mutable index in host memory, its geometry read from the checkpoint's own headers. ```c void usearch_shapes_load_ram(usearch_shapes_load_ram_t *arguments); ``` Where the parts end up is the call's own memory domains, never the manifest's: part `p` is written whole on shard `p`, beside any placed shards the parts leave empty, and the shards past the placed ones open over those domains in turn. - `index`: Output for the new index, written by the time the call is final. - `executor`: The executor the read fans out over, one shard per thread. - `outcome`: Output for the outcome, final once its status leaves [`usearch_status_deferred_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_deferred_k). - `completion`: Blocking, the default, or deferred. - `path`: Checkpoint path - a monolith, or a manifest naming many. - `ram`: The memory domains to place the parts on. - `values_per_key`: Upper bound on entries sharing one key, which no checkpoint records; zero is unbounded. - `progress`: The __optional__ handler, called with parts placed and their count. Statuses: - [`usearch_status_invalid_argument_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_invalid_argument_k) An empty `path`, or a checkpoint or part path that does not parse. - [`usearch_status_malformed_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_malformed_k) The checkpoint lists no part, or a part, its header, columns or sums do not parse. - [`usearch_status_unknown_kind_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unknown_kind_k) A checkpoint of an unknown metric. - [`usearch_status_unsupported_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unsupported_k) A checkpoint storing points other than `f16` or `f32`, or a pinned class the CPU does not admit. - [`usearch_status_uninitialized_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_uninitialized_k) The executor holds no pool workers. - [`usearch_status_config_mismatch_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_config_mismatch_k) The checkpoint's columns differ from the shards' in dtype, shape or key width. - [`usearch_status_device_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_device_k) The executor is not a RAM executor. - [`usearch_status_contended_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_contended_k) Another call holds the executor, or its pool runs another dispatch. - [`usearch_status_overflow_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_overflow_k) A part passes a shard's bound or its key multimap. ## usearch_shapes_load_ram_buffer Copies a checkpoint from a memory buffer into a new, mutable index in host memory. ```c void usearch_shapes_load_ram_buffer( usearch_shapes_load_ram_buffer_t *arguments); ``` This places, reports and cancels like [`usearch_shapes_load_ram`](#usearch_shapes_load_ram), which reaches the same bytes through a mapping, so `buffer` needs no file behind it, and a mapped file no copy. - `index`: Output for the new index, written by the time the call is final. - `executor`: The executor the read fans out over, one shard per thread. - `outcome`: Output for the outcome, final once its status leaves [`usearch_status_deferred_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_deferred_k). - `completion`: Blocking, the default, or deferred. - `buffer`: Source holding one serialized monolith, or the manifest of several parts leading them. - `ram`: The memory domains to place the parts on. - `values_per_key`: Upper bound on entries sharing one key, which no checkpoint records; zero is unbounded. - `progress`: The __optional__ handler, called with parts placed and their count. Statuses: - [`usearch_status_invalid_argument_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_invalid_argument_k) An empty `buffer`. - [`usearch_status_malformed_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_malformed_k) The manifest lists no part, or a part, its header, columns or sums do not parse. - [`usearch_status_unknown_kind_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unknown_kind_k) A checkpoint of an unknown metric. - [`usearch_status_unsupported_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unsupported_k) A checkpoint storing points other than `f16` or `f32`, or a pinned class the CPU does not admit. - [`usearch_status_uninitialized_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_uninitialized_k) The executor holds no pool workers. - [`usearch_status_config_mismatch_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_config_mismatch_k) The checkpoint's columns differ from the shards' in dtype, shape or key width. - [`usearch_status_device_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_device_k) The executor is not a RAM executor. - [`usearch_status_contended_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_contended_k) Another call holds the executor, or its pool runs another dispatch. - [`usearch_status_overflow_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_overflow_k) A part passes a shard's bound or its key multimap. ## usearch_shapes_load_vram Copies a checkpoint into a new, mutable index in device memory, with the placement rules of [`usearch_shapes_load_ram`](#usearch_shapes_load_ram). ```c void usearch_shapes_load_vram(usearch_shapes_load_vram_t *arguments); ``` - `index`: Output for the new index, written by the time the call is final. - `executor`: The executor the upload runs on, one stream per device. - `outcome`: Output for the outcome, final once its status leaves [`usearch_status_deferred_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_deferred_k). - `completion`: Blocking, the default, or deferred. - `path`: Checkpoint path - a monolith, or a manifest naming many. - `vram`: The devices to place the parts on. - `values_per_key`: Upper bound on entries sharing one key, which no checkpoint records; zero is unbounded. - `progress`: The __optional__ handler, called with parts placed and their count. Statuses: - [`usearch_status_invalid_argument_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_invalid_argument_k) An empty `path`, or a checkpoint or part path that does not parse. - [`usearch_status_malformed_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_malformed_k) The checkpoint lists no part, or a part, its header, columns or sums do not parse. - [`usearch_status_unknown_kind_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unknown_kind_k) A checkpoint of an unknown metric. - [`usearch_status_unsupported_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unsupported_k) A checkpoint of a kind other than Chamfer or Hausdorff or storing points other than `f16` or `f32`, a `values_per_key` bound, or devices that do not run the pinned class. - [`usearch_status_config_mismatch_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_config_mismatch_k) Devices of two classes, the executor driving no stream on some shard's device, or the checkpoint's columns differing from the shards' in dtype, shape or key width. - [`usearch_status_device_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_device_k) An ordinal past the listing, devices this build carries no kernels for, a build without GPU kernels, or an executor that is not a VRAM executor. - [`usearch_status_contended_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_contended_k) Another call holds the executor. - [`usearch_status_overflow_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_overflow_k) A part passes a shard's bound or its key multimap. ## usearch_shapes_load_vram_buffer Copies a checkpoint from a memory buffer into a new, mutable index in device memory, reporting and cancelling like [`usearch_shapes_load_vram`](#usearch_shapes_load_vram). ```c void usearch_shapes_load_vram_buffer( usearch_shapes_load_vram_buffer_t *arguments); ``` - `index`: Output for the new index, written by the time the call is final. - `executor`: The executor the upload runs on, one stream per device. - `outcome`: Output for the outcome, final once its status leaves [`usearch_status_deferred_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_deferred_k). - `completion`: Blocking, the default, or deferred. - `buffer`: Source holding one serialized monolith, or the manifest of several parts leading them, in host memory. - `vram`: The devices to place the parts on. - `values_per_key`: Upper bound on entries sharing one key, which no checkpoint records; zero is unbounded. - `progress`: The __optional__ handler, called with parts placed and their count. Statuses: - [`usearch_status_invalid_argument_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_invalid_argument_k) An empty `buffer`. - [`usearch_status_malformed_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_malformed_k) The manifest lists no part, or a part, its header, columns or sums do not parse. - [`usearch_status_unknown_kind_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unknown_kind_k) A checkpoint of an unknown metric. - [`usearch_status_unsupported_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unsupported_k) A `buffer` in device memory, a checkpoint of a kind other than Chamfer or Hausdorff or storing points other than `f16` or `f32`, a `values_per_key` bound, or devices that do not run the pinned class. - [`usearch_status_config_mismatch_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_config_mismatch_k) Devices of two classes, the executor driving no stream on some shard's device, or the checkpoint's columns differing from the shards' in dtype, shape or key width. - [`usearch_status_device_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_device_k) An ordinal past the listing, devices this build carries no kernels for, a build without GPU kernels, or an executor that is not a VRAM executor. - [`usearch_status_contended_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_contended_k) Another call holds the executor. - [`usearch_status_overflow_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_overflow_k) A part passes a shard's bound or its key multimap. ## usearch_shapes_view_ram Serves a checkpoint in place through a memory mapping, as a read-only index whose mutating verbs report [`usearch_status_read_only_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_read_only_k). ```c void usearch_shapes_view_ram(usearch_shapes_view_ram_t *arguments); ``` - `index`: Output for the new, read-only index. - `outcome`: Output for the outcome, final once its status leaves [`usearch_status_deferred_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_deferred_k). - `path`: Checkpoint path - a monolith, or a manifest naming many. - `ram`: The class to dispatch as; a view reads its shards from the checkpoint, so only `[usearch_ram_options_t::cpu_class](https://www.unum.cloud/docs/usearch/c/residency.md#usearch_ram_options_t)` is read. Statuses: - [`usearch_status_invalid_argument_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_invalid_argument_k) An empty `path`, or a checkpoint or part path that does not parse. - [`usearch_status_malformed_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_malformed_k) The checkpoint lists no part, or a part or its header does not parse. - [`usearch_status_unknown_kind_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unknown_kind_k) A checkpoint of an unknown metric. - [`usearch_status_unsupported_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unsupported_k) Every other checkpoint, as RAM shards cannot serve a mapping in place yet. ## usearch_shapes_view_nvme Serves a checkpoint in place from NVMe drives as a read-only index, every later call reading it through its executor's engines. ```c void usearch_shapes_view_nvme(usearch_shapes_view_nvme_t *arguments); ``` Opening reads the headers alone. Every mutating verb on the handle reports [`usearch_status_read_only_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_read_only_k), and the parts must stay unmodified until the handle is freed. - `index`: Output for the new, read-only index, written by the time the call is final. - `executor`: The NVMe executor the call is ordered on; the headers come through blocking reads. - `outcome`: Output for the outcome, final once its status leaves [`usearch_status_deferred_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_deferred_k). - `completion`: Blocking, the default, or deferred. - `path`: Checkpoint path - a monolith, or a manifest naming many. - `nvme`: The devices the parts are served from; naming none serves each where its manifest points. Statuses: - [`usearch_status_device_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_device_k) `executor` is not an NVMe executor. - [`usearch_status_invalid_argument_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_invalid_argument_k) An empty `path`, `NULL` paths for a nonzero count, or a path that does not parse or names a base off its medium's block. - [`usearch_status_malformed_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_malformed_k) The manifest names no part, or a manifest, header or row directory does not parse. - [`usearch_status_unknown_kind_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unknown_kind_k) A checkpoint of an unknown metric. - [`usearch_status_config_mismatch_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_config_mismatch_k) Parts disagreeing with this index's values, keys, node IDs or metric, or with `nvme`. - [`usearch_status_unsupported_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_unsupported_k) A checkpoint storing points other than `f16` or `f32`, or a pinned class the CPU does not admit. - [`usearch_status_uninitialized_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_uninitialized_k) The executor holds no threads or pool workers. - [`usearch_status_contended_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_contended_k) Another call holds the executor, or its pool runs another dispatch. ## usearch_shapes_metadata_read_buffer Reads the fields a checkpoint in a memory buffer froze without loading it, as [`usearch_shapes_metadata_read`](#usearch_shapes_metadata_read) reads them from a path. ```c void usearch_shapes_metadata_read_buffer( usearch_shapes_metadata_read_buffer_t *arguments); ``` - `executor`: The executor the read runs on. - `outcome`: Output for the outcome, final once its status leaves [`usearch_status_deferred_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_deferred_k). - `completion`: Blocking, the default, or deferred. - `buffer`: Source holding one serialized monolith, or the manifest of several parts leading them. - `metadata`: Output for every field the checkpoint froze. Statuses: - [`usearch_status_invalid_argument_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_invalid_argument_k) An empty `buffer`. - [`usearch_status_malformed_k`](https://www.unum.cloud/docs/usearch/c/errors.md#usearch_status_malformed_k) The manifest lists no part, or a header does not parse or spans more bytes than its part.