pixano.data.settings

Settings(*args, **kwargs)

Bases: BaseSettings

Pixano app settings

Attributes:

Name	Type	Description
library_dir	str	Local or S3 path to dataset library
aws_endpoint	str	S3 endpoint URL, use 'AWS' if not provided. Used if library_dir is an S3 path
aws_region	str	S3 region name, not always required for private storages. Used if library_dir is an S3 path
aws_access_key	str	S3 AWS access key. Used if library_dir is an S3 path
aws_secret_key	str	S3 AWS secret key. Used if library_dir is an S3 path
local_model_dir	str	Local path to models. Used if library_dir is an S3 path
data_dir	Path | S3Path	Dataset directory as Path | S3Path
model_dir	Path	Model directory as Path

Source code in pixano/data/settings.py

def __init__(self, *args, **kwargs):
    """Initialize settings"""

    super().__init__(*args, **kwargs)

    # Setup data directory
    if urlparse(self.library_dir).scheme == "s3":
        # S3 library
        try:
            self.data_dir = S3Path.from_uri(self.library_dir)
            register_configuration_parameter(
                self.data_dir,
                resource=boto3.resource(
                    "s3",
                    endpoint_url=self.aws_endpoint,
                    region_name=self.aws_region,
                    aws_access_key_id=self.aws_access_key,
                    aws_secret_access_key=self.aws_secret_key,
                ),
            )
        except Exception as e:
            raise ValueError(
                "ERROR: Could not register S3 dataset library.\n"
                "You have to set the following environment variables:\n"
                "- AWS_ENDPOINT: S3 endpoint URL, use 'AWS' if not provided\n"
                "- AWS_REGION: S3 region name, not always required for private storages\n"
                "- AWS_ACCESS_KEY: S3 AWS access key\n"
                "- AWS_SECRET_KEY: S3 AWS secret key"
            ) from e

        # Check if local model directory is provided
        if self.local_model_dir is None:
            raise AttributeError(
                "When using S3 storage, runtime models (.onnx files) must be stored locally and their directory must be provided with LOCAL_MODEL_DIR."
            )
        self.model_dir = Path(self.local_model_dir)

    else:
        # Local library
        self.data_dir = Path(self.library_dir)
        self.model_dir = self.data_dir / "models"

get_settings() cached

Get app settings

Returns:

Type	Description
Settings	App settings

Source code in pixano/data/settings.py

@lru_cache
def get_settings() -> Settings:
    """Get app settings

    Returns:
        Settings: App settings
    """

    return Settings()