Configuration

Looking for usage documentation? Check out Classification, Regression and KV cache.

`ClientOptions`

Options for the client. Can be used to override default client behavior for a single request.

ClientOptions(
    timeout: float = get_opts().TABPFN_CLIENT_TIMEOUT,
    headers: dict[str, str] = dict(),
)

Fields

Name	Type	Default	Description
`timeout`	`float`	`get_opts().TABPFN_CLIENT_TIMEOUT`	Timeout for the request in seconds.
`headers`	`dict[str, str]`	`dict()`	Headers for the request overriding the default headers.

Server API mode: synchronous, asynchronous, or chosen by the client. Fields

Name	Type	Default	Description
`AUTO`	—	`"auto"`	—
`SYNC`	—	`"sync"`	—
`ASYNC`	—	`"async"`	—

Client settings, each overridable by the environment variable of the same name. Fields

Name	Type	Default	Description
`TABPFN_TOKEN`	`str \| None`	`None`	Access token used for authentication.
`TABPFN_CLIENT_API_URL`	`str \| None`	`None`	Override for the server URL.
`TABPFN_CLIENT_MAX_THREAD_PER_UPLOAD`	`int`	`8`	Maximum threads used per upload.
`TABPFN_CLIENT_TIMEOUT`	`float`	`900.0`	Default request timeout in seconds.
`TABPFN_CLIENT_UPLOAD_TIMEOUT`	`float`	`7200.0`	Upload timeout in seconds.
`TABPFN_CLIENT_FORCE_REUPLOAD`	`bool`	`False`	Whether to re-upload datasets the server already holds.
`TABPFN_CLIENT_DEDUP_DATASETS`	`bool`	`True`	Whether to deduplicate dataset uploads.
`TABPFN_CLIENT_ASYNC_USE_ABOVE_TRAINSET_SIZE`	`int`	`50 * 1024 * 1024`	Train-set size in bytes above which the asynchronous API is used. Overridden by the server default unless set in the environment.
`TABPFN_CLIENT_ASYNC_POLL_TIMEOUT`	`float`	`7200.0`	Timeout in seconds when polling an asynchronous job. Overridden by the server default unless set in the environment.