Self-Hosted Models

The hardware and bandwidth for this mirror is donated by METANET, the Webhosting and Full Service-Cloud Provider.
If you wish to report a bug, or if you are interested in having us mirror your free-software or open-source project, please feel free to contact us at mirror[@]metanet.ch.

Self-Hosted Models

Partners who run Synthesize Bio models inside their own environment (for example, on a GPU host in their own cloud account) can use the same rsynthbio client against a self-hosted model container instead of the hosted API at app.synthesize.bio.

How it differs from the hosted path

The hosted path is asynchronous: it starts a query, polls for completion, and downloads results. A self-hosted container instead returns predictions synchronously as an Apache Arrow IPC stream. rsynthbio decodes that stream into exactly the same data frames you get from the hosted path (expression, metadata, and latents), so downstream code does not change.

Key differences:

No polling and no download URL — a single request returns the data.
Requires the optional arrow package — install it with install.packages("arrow").
No API key required — a key is only sent when SYNTHESIZE_API_KEY is set (use this if your container runs with authentication enabled).

Installation

install.packages("rsynthbio")
install.packages("arrow") # required for self-hosted mode

Enabling self-hosted mode

Set self_hosted = TRUE on a call, or enable it for the whole session with the SYNTHESIZE_SELF_HOSTED environment variable (truthy values: 1, true, yes, on).

library(rsynthbio)

Sys.setenv(SYNTHESIZE_SELF_HOSTED = "1")

Pointing each model at its container

Self-hosted deployments typically run one container per model. Set a per-model base URL once and you never have to pass api_base_url on individual calls. The variable name is SYNTHESIZE_API_BASE_URL__<MODEL>, where <MODEL> is the upper-cased model id with non-alphanumeric characters replaced by underscores (for example, gem-1-bulk becomes SYNTHESIZE_API_BASE_URL__GEM_1_BULK).

Sys.setenv(
  SYNTHESIZE_API_BASE_URL__GEM_1_BULK = "https://gem-1-bulk.internal.example",
  SYNTHESIZE_API_BASE_URL__GEM_1_SC   = "https://gem-1-sc.internal.example"
)

query <- get_example_query("gem-1-bulk", self_hosted = TRUE)$example_query
result <- predict_query(query, model_id = "gem-1-bulk", self_hosted = TRUE)

expression <- result$expression
metadata <- result$metadata

Variant slugs backed by the same container (for example, gem-1-bulk_reference-conditioning and gem-1-bulk_predict-metadata) resolve to the same per-model variable as their base model.

Resolution precedence

When api_base_url is NULL, the base URL is resolved in this order:

An explicit api_base_url argument passed to the call.
The per-model variable SYNTHESIZE_API_BASE_URL__<MODEL>.
The global SYNTHESIZE_API_BASE_URL.
The production default (https://app.synthesize.bio).

You can always override the environment by passing api_base_url directly:

result <- predict_query(
  query,
  model_id = "gem-1-bulk",
  api_base_url = "https://gem-1-bulk.internal.example",
  self_hosted = TRUE
)

Authentication (optional)

Self-hosted containers may run without authentication. If yours requires a key, set SYNTHESIZE_API_KEY and the client attaches it as a bearer token:

Sys.setenv(SYNTHESIZE_API_KEY = "your-container-api-key")

Raw responses

Pass raw_response = TRUE to receive the parsed Arrow Table and its schema metadata (including model_version, request_type, and gene_order) instead of the transformed data frames:

raw <- predict_query(
  query,
  model_id = "gem-1-bulk",
  self_hosted = TRUE,
  raw_response = TRUE
)

raw$table # an arrow::Table
raw$model_version

Session info

sessionInfo()

These binaries (installable software) and packages are in development.
They may not be fully stable and should be used with caution. We make no claims about them.