luxonis_ml.utils.environ.Environ

class documentation

class Environ(BaseSettings):

View In Hierarchy

Environment-backed configuration for Luxonis ML.

Values are read from .env and the process environment. Secret values are represented as pydantic.SecretStr so they are not exposed by default string conversion.

Constant AWS_ACCESS_KEY_ID AWS access key used by S3-compatible storage.
Constant AWS_S3_ENDPOINT_URL Optional custom S3 endpoint.
Constant AWS_SECRET_ACCESS_KEY AWS secret key used by S3-compatible storage.
Constant GOOGLE_APPLICATION_CREDENTIALS Optional Google credentials path.
Constant LOG_LEVEL Logging level. One of "DEBUG", "INFO", "WARNING", "ERROR", or "CRITICAL".
Constant LUXONIS_TELEMETRY_API_KEY Undocumented
Constant LUXONIS_TELEMETRY_BACKEND Undocumented
Constant LUXONIS_TELEMETRY_DEBUG Undocumented
Constant LUXONIS_TELEMETRY_ENABLED Undocumented
Constant LUXONIS_TELEMETRY_ENDPOINT Undocumented
Constant LUXONIS_TELEMETRY_IS_LUXONIS_CLOUD Undocumented
Constant LUXONISML_BASE_PATH Local base path for offline datasets and cache files.
Constant LUXONISML_BUCKET Optional cloud bucket for datasets.
Constant LUXONISML_DISABLE_SETUP_LOGGING Whether automatic logging setup is disabled.
Constant LUXONISML_TEAM_ID Team identifier used by dataset storage.
Constant MLFLOW_CLOUDFLARE_ID Optional Cloudflare access client ID for MLflow.
Constant MLFLOW_CLOUDFLARE_SECRET Optional Cloudflare access client secret for MLflow.
Constant MLFLOW_S3_BUCKET Optional S3 bucket used by MLflow artifacts.
Constant MLFLOW_S3_ENDPOINT_URL Optional S3 endpoint used by MLflow artifacts.
Constant MLFLOW_TRACKING_URI Optional MLflow tracking URI.
Constant POSTGRES_DB Optional PostgreSQL database name.
Constant POSTGRES_HOST Optional PostgreSQL host.
Constant POSTGRES_PASSWORD Optional PostgreSQL password.
Constant POSTGRES_PORT Optional PostgreSQL port. Must be non-negative when provided.
Constant POSTGRES_USER Optional PostgreSQL user.
Constant ROBOFLOW_API_KEY Optional Roboflow API key used by LuxonisParser.
Constant ULTRALYTICS_API_KEY Undocumented
Class Variable model_config Undocumented
Method _serialize_environ Undocumented
AWS_ACCESS_KEY_ID: SecretStr | None =

AWS access key used by S3-compatible storage.

Value
None
AWS_S3_ENDPOINT_URL: str | None =

Optional custom S3 endpoint.

Value
None
AWS_SECRET_ACCESS_KEY: SecretStr | None =

AWS secret key used by S3-compatible storage.

Value
None
GOOGLE_APPLICATION_CREDENTIALS: SecretStr | None =

Optional Google credentials path.

Value
None
LOG_LEVEL: Literal['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'] =

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

Value
'INFO'
LUXONIS_TELEMETRY_API_KEY: SecretStr | None =

Undocumented

Value
None
LUXONIS_TELEMETRY_BACKEND: str | None =

Undocumented

Value
None
LUXONIS_TELEMETRY_DEBUG: bool =

Undocumented

Value
False
LUXONIS_TELEMETRY_ENABLED: bool =

Undocumented

Value
True
LUXONIS_TELEMETRY_ENDPOINT: str | None =

Undocumented

Value
None
LUXONIS_TELEMETRY_IS_LUXONIS_CLOUD: bool =

Undocumented

Value
False
LUXONISML_BASE_PATH: Path =

Local base path for offline datasets and cache files.

Value
Path.home() / 'luxonis_ml'
LUXONISML_BUCKET: str | None =

Optional cloud bucket for datasets.

Value
None
LUXONISML_DISABLE_SETUP_LOGGING: bool =

Whether automatic logging setup is disabled.

Value
False
LUXONISML_TEAM_ID: str =

Team identifier used by dataset storage.

Value
'offline'
MLFLOW_CLOUDFLARE_ID: str | None =

Optional Cloudflare access client ID for MLflow.

Value
None
MLFLOW_CLOUDFLARE_SECRET: SecretStr | None =

Optional Cloudflare access client secret for MLflow.

Value
None
MLFLOW_S3_BUCKET: str | None =

Optional S3 bucket used by MLflow artifacts.

Value
None
MLFLOW_S3_ENDPOINT_URL: str | None =

Optional S3 endpoint used by MLflow artifacts.

Value
None
MLFLOW_TRACKING_URI: str | None =

Optional MLflow tracking URI.

Value
None
POSTGRES_DB: str | None =

Optional PostgreSQL database name.

Value
None
POSTGRES_HOST: str | None =

Optional PostgreSQL host.

Value
None
POSTGRES_PASSWORD: SecretStr | None =

Optional PostgreSQL password.

Value
None
POSTGRES_PORT: NonNegativeInt | None =

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

Value
None
POSTGRES_USER: str | None =

Optional PostgreSQL user.

Value
None
ROBOFLOW_API_KEY: SecretStr | None =

Optional Roboflow API key used by LuxonisParser.

Value
None
ULTRALYTICS_API_KEY: SecretStr | None =

Undocumented

Value
None
model_config =

Undocumented

@model_serializer(when_used='always', mode='plain')
def _serialize_environ(self) -> Params:

Undocumented