# Client Profiles Reference¶

This is a comprehensive reference. See also Use Profiles to streamline Python client setup for a practical guide with examples.

A profiles YAML file must contain a mapping with one or more keys. The keys may be any string. The value of each entry is described below.

The content below is automatically generated from a schema that is used to validate profiles when they are read.

## uri¶

URI of a Tiled server, such as

http://localhost:8000


## authentication_uri¶

URI of a Tiled OAuth2 authentication server. If this is unset, uri will be used for authentication as well, which is typically correct for simple deployments of Tiled.

By default, tiled serve ... acts is both a Resource server and an Authentication server.

For authenticated Trees. Optional unless the Tree requires authentication.

## offline¶

False by default. When true, rely solely on cache. Do not attempt to connect to server.

## direct¶

In-line service configuration. See Service Configuration reference.

## structure_clients¶

Client to read structure into. Default (“numpy”) uses numpy arrays, pandas DataFrames, and xarrays backed by numpy arrays.

structure_clients: "numpy"


structure_clients: "dask"


To use custom clients, map each structure family or spec you want to support to an import path:

structure_clients:
array: "package.module:CustomArrayClient"
dataframe: "package.module:CustomDataFrameClient"
my_custom_spec: "package.module:CUstomClient"


## cache¶

### cache.memory¶

#### cache.memory.capacity¶

Maximum memory (in bytes) that the cache may consume.

For readability it is recommended to use _ for thousands separators. Example:

available_bytes: 2_000_000_000  # 2GB


#### cache.memory.available_bytes¶

Deprecated alias for “capacity”

### cache.disk¶

#### cache.disk.path¶

A directory will be created at this path if it does not yet exist. It is safe to reuse an existing cache directory and to share a cache directory between multiple processes. available_bytes:

#### cache.disk.capacity¶

Maximum storage space (in bytes) that the cache may consume.

For readability it is recommended to use _ for thousands separators. Example:

available_bytes: 2_000_000_000  # 2GB


#### cache.disk.available_bytes¶

Deprecated alias for “capacity”

## token_cache¶

Filepath to directory of access tokens. Default location is usually suitable. The default is system-dependent and can be inspected at tiled.client.authentication.DEFAULT_TILED_TOKEN_CACHE.

## verify¶

Set to False to disable SSL verification.