Cloud Storage¶
LightlyStudio Enterprise lets admins configure cloud storage credentials centrally.
Once set up, every Python client that calls ls.connect() receives the credentials
automatically, no per-user setup is needed. Cloud storage is read-only, LightlyStudio
will not write any data to your buckets or need write permissions.
Currently supported: AWS S3. Support for GCS and Azure is planned.
How It Works¶
- Admin creates cloud provider credentials with read access to the storage bucket. See AWS S3 Setup for a step-by-step guide.
- Admin saves the credentials in the LightlyStudio Enterprise GUI.
- Python clients call
ls.connect()and receive the credentials automatically.
Step 1: Get Your Cloud Credentials¶
Follow the guide for your cloud provider to create credentials with the required permissions:
Step 2: Add Credentials in the GUI¶
- Open your LightlyStudio Enterprise instance in the browser.
- Go to the Datasets page and click the Cloud Storage Credentials button. This button is only visible to admins.
- Enter the Access Key ID and Secret Access Key you created in the previous step.
- Click Save Credentials.
The credentials are now stored on the server and shared with all Python client connections.
Step 3: Use Cloud Storage from Python¶
If you have not set up Python access yet, start with
Connect from Python. After calling ls.connect(), cloud credentials are
injected into your local environment automatically, so you can use remote paths directly
without any extra client-side setup.
import lightly_studio as ls
ls.connect()
dataset = ls.ImageDataset.load_or_create("s3_dataset")
dataset.add_images_from_path(path="s3://my-bucket/images/")
Note
The Python client must have the cloud storage dependencies installed:
pip install "lightly-studio[cloud-storage]"