# environ

Python API: `luxonis_ml.utils.environ`

## Classes

| Name | Description |
| --- | --- |
|
[`Environ`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/utils/environ.md)
| Environment-backed configuration for Luxonis ML. |

### class `Environ`

```python
class Environ(BaseSettings)
```

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

| Name | Type | Description |
| --- | --- | --- |
| `AWS_ACCESS_KEY_ID` | `SecretStr | None` | AWS access key used by S3-compatible storage. |
| `AWS_S3_ENDPOINT_URL` | `str | None` | Optional custom S3 endpoint. |
| `AWS_SECRET_ACCESS_KEY` | `SecretStr | None` | AWS secret key used by S3-compatible storage. |
| `GOOGLE_APPLICATION_CREDENTIALS` | `SecretStr | None` | Optional Google credentials path. |
| `LOG_LEVEL` | `Literal['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL']` | Logging level. One of `"DEBUG"`, `"INFO"`,
`"WARNING"`, `"ERROR"`, or `"CRITICAL"`. |
| `LUXONIS_TELEMETRY_API_KEY` | `SecretStr | None` |  |
| `LUXONIS_TELEMETRY_BACKEND` | `str | None` |  |
| `LUXONIS_TELEMETRY_DEBUG` | `bool` |  |
| `LUXONIS_TELEMETRY_ENABLED` | `bool` |  |
| `LUXONIS_TELEMETRY_ENDPOINT` | `str | None` |  |
| `LUXONIS_TELEMETRY_IS_LUXONIS_CLOUD` | `bool` |  |
| `LUXONISML_BASE_PATH` | `Path` | Local base path for offline datasets and cache files. |
| `LUXONISML_BUCKET` | `str | None` | Optional cloud bucket for datasets. |
| `LUXONISML_DISABLE_PRETTY_VALIDATION_ERRORS` | `bool` | Whether automatic validation error summaries are disabled. |
| `LUXONISML_DISABLE_SETUP_LOGGING` | `bool` | Whether automatic logging setup is disabled. |
| `LUXONISML_TEAM_ID` | `str` | Team identifier used by dataset storage. |
| `MLFLOW_CLOUDFLARE_ID` | `str | None` | Optional Cloudflare access client ID for MLflow. |
| `MLFLOW_CLOUDFLARE_SECRET` | `SecretStr | None` | Optional Cloudflare access client secret for MLflow. |
| `MLFLOW_S3_BUCKET` | `str | None` | Optional S3 bucket used by MLflow artifacts. |
| `MLFLOW_S3_ENDPOINT_URL` | `str | None` | Optional S3 endpoint used by MLflow artifacts. |
| `MLFLOW_TRACKING_URI` | `str | None` | Optional MLflow tracking URI. |
| `model_config` |  |  |
| `POSTGRES_DB` | `str | None` | Optional PostgreSQL database name. |
| `POSTGRES_HOST` | `str | None` | Optional PostgreSQL host. |
| `POSTGRES_PASSWORD` | `SecretStr | None` | Optional PostgreSQL password. |
| `POSTGRES_PORT` | `NonNegativeInt | None` | Optional PostgreSQL port. Must be non-negative when provided. |
| `POSTGRES_USER` | `str | None` | Optional PostgreSQL user. |
| `ROBOFLOW_API_KEY` | `SecretStr | None` | 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` | `SecretStr | None` |  |

## Module Attributes

| Name | Type | Description |
| --- | --- | --- |
|
[`environ`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/utils/environ.md)
| `Environ` | |

### variable `environ`

```python
environ: Environ = cast(Environ, _proxy)
```
