# environ

Python API: `luxonis_ml.utils.environ`

## Classes

### Environ

Environment-backed configuration for Luxonis ML.

Values are read from `.env` and the process environment. Secret values are represented as
[pydantic.SecretStr](https://pydantic.dev/docs/validation/2.0/usage/types/secrets/) so they are not exposed by default string
conversion.

#### Attributes

##### AWS_ACCESS_KEY_ID

AWS access key used by S3-compatible storage.

##### AWS_S3_ENDPOINT_URL

Optional custom S3 endpoint.

##### AWS_SECRET_ACCESS_KEY

AWS secret key used by S3-compatible storage.

##### GOOGLE_APPLICATION_CREDENTIALS

Optional Google credentials path.

##### LOG_LEVEL

Logging level. One of `"DEBUG"`, `"INFO"`, `"WARNING"`, `"ERROR"`, or `"CRITICAL"`.

##### LUXONIS_TELEMETRY_API_KEY

##### LUXONIS_TELEMETRY_BACKEND

##### LUXONIS_TELEMETRY_DEBUG

##### LUXONIS_TELEMETRY_ENABLED

##### LUXONIS_TELEMETRY_ENDPOINT

##### LUXONIS_TELEMETRY_IS_LUXONIS_CLOUD

##### LUXONISML_BASE_PATH

Local base path for offline datasets and cache files.

##### LUXONISML_BUCKET

Optional cloud bucket for datasets.

##### LUXONISML_DISABLE_SETUP_LOGGING

Whether automatic logging setup is disabled.

##### LUXONISML_TEAM_ID

Team identifier used by dataset storage.

##### MLFLOW_CLOUDFLARE_ID

Optional Cloudflare access client ID for MLflow.

##### MLFLOW_CLOUDFLARE_SECRET

Optional Cloudflare access client secret for MLflow.

##### MLFLOW_S3_BUCKET

Optional S3 bucket used by MLflow artifacts.

##### MLFLOW_S3_ENDPOINT_URL

Optional S3 endpoint used by MLflow artifacts.

##### MLFLOW_TRACKING_URI

Optional MLflow tracking URI.

##### model_config

##### POSTGRES_DB

Optional PostgreSQL database name.

##### POSTGRES_HOST

Optional PostgreSQL host.

##### POSTGRES_PASSWORD

Optional PostgreSQL password.

##### POSTGRES_PORT

Optional PostgreSQL port. Must be non-negative when provided.

##### POSTGRES_USER

Optional PostgreSQL user.

##### ROBOFLOW_API_KEY

Optional Roboflow API key used by
[LuxonisParser](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/data/parsers/luxonis_parser.md).

##### ULTRALYTICS_API_KEY

## Attributes

### environ