Keep artifacts local in a cloud instance

If you want to default to keeping artifacts local in a cloud instance, enable keep_artifacts_local.

Hide code cell content
!lamin login testuser1
!lamin init --storage s3://lamindb-ci/keep-artifacts-local
✓ logged in with email [email protected] (uid: DzTjkKse)
→ go to: https://lamin.ai/testuser1/keep-artifacts-local
! updating cloud SQLite 's3://lamindb-ci/keep-artifacts-local/cc7f2489bf7251f79ff9ca8df7ac045b.lndb' of instance 'testuser1/keep-artifacts-local'
→ connected lamindb: testuser1/keep-artifacts-local
! locked instance (to unlock and push changes to the cloud SQLite file, call: lamin disconnect)
# !pip install 'lamindb[jupyter,aws]'
import lamindb as ln

ln.track("l9lFf83aPwRc0000")
→ connected lamindb: testuser1/keep-artifacts-local
→ notebook imports: lamindb==0.76.14
→ created Transform('l9lFf83a'), started new Run('7sKbzvHF') at 2024-10-30 03:40:19 UTC
Hide code cell content
# the setting should be enabled on lamin.ai
# we're temporarily setting it here only for testing purposes
ln.setup.settings.instance._keep_artifacts_local = True

You can register a managed local storage location as follows:

ln.settings.storage_local = "./my_storage_local"
→ defaulting to local storage: /home/runner/work/lamindb/lamindb/docs/faq/my_storage_local

Now, you have two storage locations: one in the S3 bucket, and the other locally.

ln.Storage.df()
Hide code cell output
uid root description type region instance_uid run_id created_at created_by_id
id
2 cQUcS6lnlRuY /home/runner/work/lamindb/lamindb/docs/faq/my_... None local None 6uGWmLpZlNoJ None 2024-10-30 03:40:21.753107+00:00 1
1 naM41G2PyzOJ s3://lamindb-ci/keep-artifacts-local None s3 us-west-1 6uGWmLpZlNoJ None 2024-10-30 03:40:13.087099+00:00 1

Update storage description

You can add a description to the storage by using the description parameter:

storage_record = ln.Storage.get(root=ln.settings.storage_local.root)
storage_record.description = "Files stored locally in site X on server Y for reason ABC"
storage_record.save()
ln.Storage.df()
uid root description type region instance_uid run_id created_at created_by_id
id
2 cQUcS6lnlRuY /home/runner/work/lamindb/lamindb/docs/faq/my_... Files stored locally in site X on server Y for... local None 6uGWmLpZlNoJ None 2024-10-30 03:40:21.753107+00:00 1
1 naM41G2PyzOJ s3://lamindb-ci/keep-artifacts-local None s3 us-west-1 6uGWmLpZlNoJ None 2024-10-30 03:40:13.087099+00:00 1

Use local storage

If you save an artifact, by default, it’s stored in local storage.

original_filepath = ln.core.datasets.file_fcs()
artifact = ln.Artifact(original_filepath, description="My fcs file").save()
local_path = artifact.path
local_path
Hide code cell output
PosixUPath('/home/runner/work/lamindb/lamindb/docs/faq/my_storage_local/.lamindb/O8aKMLm79ay9jlaE0000.fcs')

You’ll see the .fcs file named by the uid in your .lamindb/ directory under ./my_storage_local/:

ln.settings.storage_local.root.view_tree()
Hide code cell output
1 sub-directory & 2 files with suffixes '', '.fcs'
/home/runner/work/lamindb/lamindb/docs/faq/my_storage_local
└── .lamindb/
    ├── _is_initialized
    └── O8aKMLm79ay9jlaE0000.fcs
Hide code cell content
assert local_path.exists()
assert artifact.path.as_posix().startswith(ln.settings.storage_local.root.as_posix())

If you’d like to upload an artifact, you pass upload=True to the save() method.

artifact.save(upload=True)
Hide code cell output
→ moved local artifact to cache: /home/runner/.cache/lamindb/O8aKMLm79ay9jlaE0000.fcs
Artifact(uid='O8aKMLm79ay9jlaE0000', is_latest=True, description='My fcs file', suffix='.fcs', size=6785467, hash='KCEXRahJ-Ui9Y6nksQ8z1A', _hash_type='md5', visibility=1, _key_is_virtual=True, storage_id=1, transform_id=1, run_id=1, created_by_id=1, created_at=2024-10-30 03:40:22 UTC)

You now see the artifact in the S3 bucket:

ln.setup.settings.storage.root.view_tree()
Hide code cell output
2 sub-directories & 3 files with suffixes '', '.lndb', '.fcs'
s3://lamindb-ci/keep-artifacts-local
├── cc7f2489bf7251f79ff9ca8df7ac045b.lndb
└── .lamindb/
    ├── O8aKMLm79ay9jlaE0000.fcs
    ├── _is_initialized
    └── _exclusion/

And it’s no longer present in local storage:

ln.setup.settings.instance.storage_local.root.view_tree()
Hide code cell output
1 sub-directory & 1 files with suffixes ''
/home/runner/work/lamindb/lamindb/docs/faq/my_storage_local
└── .lamindb/
    └── _is_initialized
Hide code cell content
assert artifact.path.exists()
assert not local_path.exists()
assert artifact.path.as_posix().startswith(ln.setup.settings.instance.storage.root.as_posix())

Direct upload

You can also directly upload a file by passing upload=True:

filepath = ln.core.datasets.file_mini_csv()
artifact2 = ln.Artifact(filepath, description="My csv file").save(upload=True)
artifact2.path
Hide code cell output
S3Path('s3://lamindb-ci/keep-artifacts-local/.lamindb/RggN7ouQ3Pyhz5Er0000.csv')

Now we have two files on S3:

ln.Artifact.df(include="storage__root")
Hide code cell output
storage__root uid version is_latest description key suffix type size hash ... n_observations _hash_type _accessor visibility _key_is_virtual storage_id transform_id run_id created_at created_by_id
id
2 s3://lamindb-ci/keep-artifacts-local RggN7ouQ3Pyhz5Er0000 None True My csv file None .csv None 11 z1LdF2qN4cN0M2sXrcW8aw ... None md5 None 1 True 1 1 1 2024-10-30 03:40:23.172018+00:00 1
1 s3://lamindb-ci/keep-artifacts-local O8aKMLm79ay9jlaE0000 None True My fcs file None .fcs None 6785467 KCEXRahJ-Ui9Y6nksQ8z1A ... None md5 None 1 True 1 1 1 2024-10-30 03:40:22.785504+00:00 1

2 rows × 21 columns

Hide code cell content
assert artifact2.path.exists()

Pre-existing artifacts

Assume we already have a file in our registered local storage location:

Hide code cell source
file_in_local_storage = ln.core.datasets.file_bam()
file_in_local_storage.rename("./my_storage_local/output.bam")
ln.UPath("my_storage_local/").view_tree()
1 sub-directory & 2 files with suffixes '', '.bam'
/home/runner/work/lamindb/lamindb/docs/faq/my_storage_local
├── .lamindb/
│   └── _is_initialized
└── output.bam

If we create an artifact from it, it remains where it is during saving:

my_existing_file = ln.Artifact("./my_storage_local/output.bam", description="my existing file").save()
ln.UPath("my_storage_local/").view_tree()
Hide code cell output
1 sub-directory & 2 files with suffixes '', '.bam'
/home/runner/work/lamindb/lamindb/docs/faq/my_storage_local
├── .lamindb/
│   └── _is_initialized
└── output.bam

The storage path of the artifact is constructed using key because key_is_virtual=False:

my_existing_file
Hide code cell output
Artifact(uid='Mo2A1WwZ8hl5QGlR0000', is_latest=True, description='my existing file', key='output.bam', suffix='.bam', size=18, hash='D2yxELM5U3VLeyvrwWUMUA', _hash_type='md5', visibility=1, _key_is_virtual=False, storage_id=2, transform_id=1, run_id=1, created_by_id=1, created_at=2024-10-30 03:40:23 UTC)

However, if we decide to upload the artifact, we’ll use the uid for constructing the storage path and switch key_is_virtual=True:

my_existing_file.save(upload=True)
Hide code cell output
→ moved local artifact to cache: /home/runner/.cache/lamindb/output.bam
Artifact(uid='Mo2A1WwZ8hl5QGlR0000', is_latest=True, description='my existing file', key='output.bam', suffix='.bam', size=18, hash='D2yxELM5U3VLeyvrwWUMUA', _hash_type='md5', visibility=1, _key_is_virtual=True, storage_id=1, transform_id=1, run_id=1, created_by_id=1, created_at=2024-10-30 03:40:23 UTC)

Here is the remote path of the artifact:

my_existing_file.path
Hide code cell output
S3Path('s3://lamindb-ci/keep-artifacts-local/.lamindb/Mo2A1WwZ8hl5QGlR0000.bam')

And here are the contents of the storage locations:

# the path on S3
ln.setup.settings.storage.root.view_tree()
# the local path
ln.setup.settings.instance.storage_local.root.view_tree()
Hide code cell output
2 sub-directories & 5 files with suffixes '', '.bam', '.csv', '.fcs', '.lndb'
s3://lamindb-ci/keep-artifacts-local
├── cc7f2489bf7251f79ff9ca8df7ac045b.lndb
└── .lamindb/
    ├── Mo2A1WwZ8hl5QGlR0000.bam
    ├── O8aKMLm79ay9jlaE0000.fcs
    ├── RggN7ouQ3Pyhz5Er0000.csv
    ├── _is_initialized
    └── _exclusion/
1 sub-directory & 1 files with suffixes ''
/home/runner/work/lamindb/lamindb/docs/faq/my_storage_local
└── .lamindb/
    └── _is_initialized

Delete the test instance

Delete the artifacts:

artifact.delete(permanent=True)
artifact2.delete(permanent=True)
my_existing_file.delete(permanent=True)

Delete the instance:

ln.setup.delete("keep-artifacts-local", force=True)
Hide code cell output
→ deleted storage record on hub 5cab862651ef431d838ee4918266b3fb
→ deleted storage record on hub eb35d80e9c4d5d02aab65a03c95bb70c
→ deleted instance record on hub cc7f2489bf7251f79ff9ca8df7ac045b