Redun
¶
Here, we’ll see how to track redun workflows with lamindb.
Note
This guide is based on github.com/ricomnl/bioinformatics-pipeline-tutorial.
Amend the workflow¶
Here is how to instrument a redun workflow for tracking with lamindb:
Add
ln.track()to themain()task (see on GitHub)Register desired output files or folders by creating artifacts for them (see on GitHub):
ln.Artifact(output_path, key="data/results.tar.gz").save()
Add a
finish()task that callsln.finish()(see on GitHub)Optionally cache/stage input files (see on GitHub)
Why not use @ln.flow() for main()?
Because main() in redun is typically a scheduler/executor task rather than a task that performs the actual computation. ln.flow() would then just track the execution time of scheduling, and not an actual compute run.
If one wanted to use @ln.flow() it’s advisable to wrap the scheduling main() task:
@ln.flow()
def run_pipeline(...):
scheduler = Scheduler()
result = scheduler.run(main(...)) # run the main task
ln.Artifact(result.path, key="data/results.tgz").save()
return result
Run redun¶
Let’s see what the input files are:
ls ./fasta
Show code cell output
KLF4.fasta
MYC.fasta
PO5F1.fasta
SOX2.fasta
Create a lamindb test instance:
# pip install lamindb redun git+http://github.com/laminlabs/redun-lamin-fasta
lamin init --storage ./test-redun-lamin
Show code cell output
→ initialized database testuser1/test-redun-lamin in /home/runner/work/redun-lamin/redun-
lamin/docs
Register each input file individually as an artifact:
import lamindb as ln
import json
ln.Artifact.from_dir("./fasta").save()
Show code cell output
→ connected lamindb: testuser1/test-redun-lamin
! folder is outside existing storage location, will copy files from ./fasta to /home/runner/work/redun-lamin/redun-lamin/docs/test-redun-lamin/fasta
! no run & transform got linked, call `ln.track()` & re-run
! no run & transform got linked, call `ln.track()` & re-run
! no run & transform got linked, call `ln.track()` & re-run
! no run & transform got linked, call `ln.track()` & re-run
SQLRecordList([Artifact(uid='EpZOG8QJMUdGNxfz0000', key='fasta/KLF4.fasta', description=None, suffix='.fasta', kind=None, otype=None, size=609, hash='LyuoYkWs4SgYcH7P7JLJtA', n_files=None, n_observations=None, extra_data=None, branch_id=1, created_on_id=1, space_id=1, storage_id=1, run_id=None, schema_id=None, created_by_id=1, created_at=2026-10-03 08:34:00 UTC, is_locked=False, version_tag=None, is_latest=True),
Artifact(uid='QIOiQAbJQb9ME44c0000', key='fasta/MYC.fasta', description=None, suffix='.fasta', kind=None, otype=None, size=536, hash='WGbEtzPw-3bQEGcngO_pHQ', n_files=None, n_observations=None, extra_data=None, branch_id=1, created_on_id=1, space_id=1, storage_id=1, run_id=None, schema_id=None, created_by_id=1, created_at=2026-10-03 08:34:00 UTC, is_locked=False, version_tag=None, is_latest=True),
Artifact(uid='ish1Z2l1f5W09iWm0000', key='fasta/PO5F1.fasta', description=None, suffix='.fasta', kind=None, otype=None, size=477, hash='-7iJgveFO9ia0wE1bqVu6g', n_files=None, n_observations=None, extra_data=None, branch_id=1, created_on_id=1, space_id=1, storage_id=1, run_id=None, schema_id=None, created_by_id=1, created_at=2026-10-03 08:34:00 UTC, is_locked=False, version_tag=None, is_latest=True),
Artifact(uid='Ng1u2lOo9Y0b5lGF0000', key='fasta/SOX2.fasta', description=None, suffix='.fasta', kind=None, otype=None, size=414, hash='C5q_yaFXGk4SAEpfdqBwnQ', n_files=None, n_observations=None, extra_data=None, branch_id=1, created_on_id=1, space_id=1, storage_id=1, run_id=None, schema_id=None, created_by_id=1, created_at=2026-10-03 08:34:00 UTC, is_locked=False, version_tag=None, is_latest=True)])
Run the redun workflow:
redun run workflow.py main --input-dir ./fasta --tag run=test-run 1> run_logs.txt 2>run_logs.txt
Inspect the logs:
cat run_logs.txt
Show code cell output
→ connected lamindb: testuser1/test-redun-lamin
→ script invoked with: run wor
kflow.py main --input-dir ./fasta --tag run=test-run
→ created Transform('Gvr2Lm1JgklA000
0', key='workflow.py'), started new Run('dIeMzR5sauXuMiDN') at 2026-10-03 08:34:12 UTC
•
tip: to identify the script across renames, pass the uid: ln.track("Gvr2Lm1JgklA")
File(path=/home/r
unner/work/redun-lamin/redun-lamin/docs/test-redun-lamin/data/results.tgz, hash=502737c0)
cs_pipelin
e_tutorial.lib.digest_protein_task(input_fasta=File(path=/home/runner/work/redun-lamin/redun-lamin/d
ocs/test-redun-lamin/.lamindb/EpZOG8QJMUdGNxfz0000.fasta, hash=5b9ae247), enzyme_regex='[KR]', misse
d_cleavages=0, min_length=4, max_length=75) on default
[redun] Run Job 62176c5d: bioinformatics_
pipeline_tutorial.lib.digest_protein_task(input_fasta=File(path=/home/runner/work/redun-lamin/redun-
lamin/docs/test-redun-lamin/.lamindb/QIOiQAbJQb9ME44c0000.fasta, hash=cd7cb68c), enzyme_regex='[KR]'
, missed_cleavages=0, min_length=4, max_length=75) on default
[redun] Run Job 1e906c33: bioinfor
matics_pipeline_tutorial.lib.digest_protein_task(input_fasta=File(path=/home/runner/work/redun-lamin
/redun-lamin/docs/test-redun-lamin/.lamindb/ish1Z2l1f5W09iWm0000.fasta, hash=b1680700), enzyme_regex
='[KR]', missed_cleavages=0, min_length=4, max_length=75) on default
[redun] Run Job 0c292428: b
ioinformatics_pipeline_tutorial.lib.digest_protein_task(input_fasta=File(path=/home/runner/work/redu
n-lamin/redun-lamin/docs/test-redun-lamin/.lamindb/Ng1u2lOo9Y0b5lGF0000.fasta, hash=bb21c4d3), enzym
e_regex='[KR]', missed_cleavages=0, min_length=4, max_length=75) on default
[redun] Run Job 8fcf5
d4f: bioinformatics_pipeline_tutorial.lib.count_amino_acids_task(input_fasta=File(path=/home/runner
/work/redun-lamin/redun-lamin/docs/test-redun-lamin/.lamindb/EpZOG8QJMUdGNxfz0000.fasta, hash=5b9ae2
47), input_peptides=File(path=/home/runner/work/redun-lamin/redun-lamin/docs/test-redun-lamin/data/E
pZOG8QJMUdGNxfz0000.peptides.txt, hash=67df13a2), amino_acid='C') on default
[redun] Run Job 85d4
81c2: bioinformatics_pipeline_tutorial.lib.count_amino_acids_task(input_fasta=File(path=/home/runne
r/work/redun-lamin/redun-lamin/docs/test-redun-lamin/.lamindb/QIOiQAbJQb9ME44c0000.fasta, hash=cd7cb
68c), input_peptides=File(path=/home/runner/work/redun-lamin/redun-lamin/docs/test-redun-lamin/data/
QIOiQAbJQb9ME44c0000.peptides.txt, hash=61dd7076), amino_acid='C') on default
[redun] Run Job 307
4d48c: bioinformatics_pipeline_tutorial.lib.count_amino_acids_task(input_fasta=File(path=/home/runn
er/work/redun-lamin/redun-lamin/docs/test-redun-lamin/.lamindb/ish1Z2l1f5W09iWm0000.fasta, hash=b168
0700), input_peptides=File(path=/home/runner/work/redun-lamin/redun-lamin/docs/test-redun-lamin/data
/ish1Z2l1f5W09iWm0000.peptides.txt, hash=f2393f8a), amino_acid='C') on default
[redun] Run Job ac
d2d8b9: bioinformatics_pipeline_tutorial.lib.count_amino_acids_task(input_fasta=File(path=/home/run
ner/work/redun-lamin/redun-lamin/docs/test-redun-lamin/.lamindb/Ng1u2lOo9Y0b5lGF0000.fasta, hash=bb2
1c4d3), input_peptides=File(path=/home/runner/work/redun-lamin/redun-lamin/docs/test-redun-lamin/dat
a/Ng1u2lOo9Y0b5lGF0000.peptides.txt, hash=395191bf), amino_acid='C') on default
[redun] Run Job 1
eb9c488: bioinformatics_pipeline_tutorial.lib.plot_count_task(input_count=File(path=/home/runner/wo
rk/redun-lamin/redun-lamin/docs/test-redun-lamin/data/EpZOG8QJMUdGNxfz0000.count.tsv, hash=b174f68b)
) on default
[redun] Run Job 09dffd1d: bioinformatics_pipeline_tutorial.lib.plot_count_task(inpu
t_count=File(path=/home/runner/work/redun-lamin/redun-lamin/docs/test-redun-lamin/data/QIOiQAbJQb9ME
44c0000.count.tsv, hash=e289d289)) on default
[redun] Run Job 11b98e2c: bioinformatics_pipeline_
tutorial.lib.plot_count_task(input_count=File(path=/home/runner/work/redun-lamin/redun-lamin/docs/te
st-redun-lamin/data/ish1Z2l1f5W09iWm0000.count.tsv, hash=cca238d3)) on default
[redun] Run Job 44
05faf5: bioinformatics_pipeline_tutorial.lib.plot_count_task(input_count=File(path=/home/runner/wor
k/redun-lamin/redun-lamin/docs/test-redun-lamin/data/Ng1u2lOo9Y0b5lGF0000.count.tsv, hash=b12e90be))
on default
[redun] Run Job 3adb045a: bioinformatics_pipeline_tutorial.lib.get_report_task(input
_counts=[File(path=/home/runner/work/redun-lamin/redun-lamin/docs/test-redun-lamin/data/EpZOG8QJMUdG
Nxfz0000.count.tsv, hash=b174f68b), File(path=/home/runner/work/redun-lamin/redun-lamin/docs/test-re
dun-l...) on default
[redun] Run Job 2608db14: bioinformatics_pipeline_tutorial.lib.archive_resu
lts_task(inputs_plots=[File(path=/home/runner/work/redun-lamin/redun-lamin/docs/test-redun-lamin/dat
a/EpZOG8QJMUdGNxfz0000.plot.png, hash=a2b159b0), File(path=/home/runner/work/redun-lamin/redun-lamin
/docs/test-redun-la..., input_report=File(path=/home/runner/work/redun-lamin/redun-lamin/docs/test-r
edun-lamin/data/protein_report.tsv, hash=6794f5ad)) on default
[redun] Run Job 0bebb286: redun_l
amin_fasta.finish(results_archive=File(path=/home/runner/work/redun-lamin/redun-lamin/docs/test-redu
n-lamin/data/results.tgz, hash=502737c0)) on default
[redun]
[redun] | JOB STATUS 2026/10/03 08:34:
32
[redun] | TASK PENDING RUNNING FAILED CA
CHED DONE TOTAL
[redun] |
[redun] | ALL
0 0 0 0 16 16
[redun] | bioinformatics_pipeline_tutorial.lib.arc
hive_results_task 0 0 0 0 1 1
[redun] | bioinformatics_pipelin
e_tutorial.lib.count_amino_acids_task 0 0 0 0 4 4
[redun] | bioi
nformatics_pipeline_tutorial.lib.digest_protein_task 0 0 0 0 4
4
[redun] | bioinformatics_pipeline_tutorial.lib.get_report_task 0 0 0
0 1 1
[redun] | bioinformatics_pipeline_tutorial.lib.plot_count_task 0
0 0 0 4 4
[redun] | redun_lamin_fasta.finish
0 0 0 0 1 1
[redun] | redun_lamin_fasta.main
0 0 0 0 1 1
[redun]
[redun]
[redun
] Execution duration: 19.71 seconds
View data lineage¶
artifact = ln.Artifact.get(key="data/results.tgz")
artifact.view_lineage()
Show code cell output
artifact.transform.describe()
Show code cell output
Transform: workflow.py (0000) | description: CLI: redun ├── uid: Gvr2Lm1JgklA0000 │ hash: zjZMEeofUMp3FV6fxbgjYg type: script │ branch: main space: all │ created_at: 2026-10-03 08:34:12 UTC created_by: testuser1 └── source_code: │ """workflow.py.""" │ │ # This code is based on a copy from https://github.com/ricomnl/bioinformatics-pi … │ # Copyright Rico Meinl 2022 │ from enum import Enum │ │ import lamindb as ln │ from redun import File, task │ │ import redun_lamin_fasta │ from redun_lamin_fasta.lib import ( │ archive_results_task, │ count_amino_acids_task, │ digest_protein_task, │ get_report_task, │ plot_count_task, │ ) │ │ redun_namespace = redun_lamin_fasta.__name__ │ │ │ class Executor(str, Enum): │ default = "default" │ process = "process" │ batch = "batch" │ batch_debug = "batch_debug" │ │ │ @task() │ def finish(results_archive: File) -> File: │ …
artifact.run.describe()
Show code cell output
Run: dIeMzR5 (workflow.py) ├── uid: dIeMzR5sauXuMiDN transform: workflow.py (0000) │ started_at: 2026-10-03 08:34:12 UTC finished_at: 2026-10-03 08:34:32 UTC │ status: completed │ branch: main space: all │ created_at: 2026-10-03 08:34:12 UTC created_by: testuser1 ├── cli_args: │ │ run workflow.py main --input-dir ./fasta --tag run=test-run ├── report: 5XtAbFs │ │ → connected lamindb: testuser1/test-redun-lamin │ │ → created Transform('Gvr2Lm1JgklA0000', key='workflow.py'), started new Run('dIe … │ │ • tip: to identify the script across renames, pass the uid: ln.track("Gvr2Lm1Jgk … └── environment: GvHyUaN │ aiobotocore==3.9.2 │ aiohappyeyeballs==2.7.1 │ aiohttp==3.14.3 │ aioitertools==0.13.0 │ …
Explore the run on the hub¶
→ lamin.ai/laminlabs/lamindata/transform/taasWKawCiNA
View the database content¶
ln.view()
Show code cell output
Artifact
| uid | key | description | suffix | kind | otype | size | hash | n_files | n_observations | ... | is_latest | is_locked | created_at | branch_id | created_on_id | space_id | storage_id | run_id | schema_id | created_by_id | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| id | |||||||||||||||||||||
| 6 | 8enFfTGvMalCTMvv0000 | data/results.tgz | None | None | None | 94856 | fxkWSzvKl-GblKU53YdqGA | None | None | ... | True | False | 2026-10-03 08:34:32.124+00:00 | 1 | 1 | 1 | 1 | 1.0 | None | 1 | |
| 4 | Ng1u2lOo9Y0b5lGF0000 | fasta/SOX2.fasta | None | .fasta | None | None | 414 | C5q_yaFXGk4SAEpfdqBwnQ | None | None | ... | True | False | 2026-10-03 08:34:00.780+00:00 | 1 | 1 | 1 | 1 | NaN | None | 1 |
| 3 | ish1Z2l1f5W09iWm0000 | fasta/PO5F1.fasta | None | .fasta | None | None | 477 | -7iJgveFO9ia0wE1bqVu6g | None | None | ... | True | False | 2026-10-03 08:34:00.779+00:00 | 1 | 1 | 1 | 1 | NaN | None | 1 |
| 2 | QIOiQAbJQb9ME44c0000 | fasta/MYC.fasta | None | .fasta | None | None | 536 | WGbEtzPw-3bQEGcngO_pHQ | None | None | ... | True | False | 2026-10-03 08:34:00.779+00:00 | 1 | 1 | 1 | 1 | NaN | None | 1 |
| 1 | EpZOG8QJMUdGNxfz0000 | fasta/KLF4.fasta | None | .fasta | None | None | 609 | LyuoYkWs4SgYcH7P7JLJtA | None | None | ... | True | False | 2026-10-03 08:34:00.778+00:00 | 1 | 1 | 1 | 1 | NaN | None | 1 |
5 rows × 22 columns
Run
| uid | name | description | entrypoint | started_at | finished_at | params | extra_data | reference | reference_type | ... | created_at | branch_id | created_on_id | space_id | transform_id | report_id | environment_id | plan_id | created_by_id | initiated_by_run_id | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| id | |||||||||||||||||||||
| 1 | dIeMzR5sauXuMiDN | None | None | None | 2026-10-03 08:34:12.720+00:00 | 2026-10-03 08:34:32.148674+00:00 | None | None | None | None | ... | 2026-10-03 08:34:12.720+00:00 | 1 | 1 | 1 | 1 | 7 | 5 | None | 1 | None |
1 rows × 22 columns
Storage
| uid | root | description | type | region | instance_uid | is_locked | created_at | branch_id | created_on_id | space_id | created_by_id | run_id | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| id | |||||||||||||
| 1 | mIvOu3bVrBs6 | /home/runner/work/redun-lamin/redun-lamin/docs... | None | local | None | iQlBPgD8uaqR | False | 2026-10-03 08:33:59.679+00:00 | 1 | 1 | 1 | 1 | None |
Transform
| uid | key | description | kind | source_code | hash | reference | reference_type | version_tag | is_latest | is_locked | created_at | branch_id | created_on_id | space_id | environment_id | plan_id | run_id | created_by_id | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| id | |||||||||||||||||||
| 1 | Gvr2Lm1JgklA0000 | workflow.py | CLI: redun | script | """workflow.py."""\n\n# This code is based on ... | zjZMEeofUMp3FV6fxbgjYg | None | None | None | True | False | 2026-10-03 08:34:12.686+00:00 | 1 | 1 | 1 | None | None | None | 1 |
Appendix¶
Map the redun execution id¶
Export the run information from redun:
redun log --exec --exec-tag run=test-run --format json --no-pager > redun_exec.json
Map it on the run reference:
# load the redun execution id from the JSON and store it in the LaminDB run record
with open("redun_exec.json") as file:
redun_exec = json.loads(file.readline())
artifact.run.reference = redun_exec["id"]
artifact.run.reference_type = "redun_id"
artifact.run.save()
Show code cell output
Run(uid='dIeMzR5sauXuMiDN', name=None, description=None, entrypoint=None, started_at=2026-10-03 08:34:12 UTC, finished_at=2026-10-03 08:34:32 UTC, params=None, extra_data=None, reference='4ccda618-ed9a-4cc3-87c4-026e1e433677', reference_type='redun_id', cli_args='run workflow.py main --input-dir ./fasta --tag run=test-run', branch_id=1, created_on_id=1, space_id=1, transform_id=1, report_id=7, environment_id=5, plan_id=None, created_by_id=1, initiated_by_run_id=None, created_at=2026-10-03 08:34:12 UTC, is_locked=False)
Map the redun run report¶
While lamindb auto-tracks the logs of the main python process you might also want to link the dedicated redun logs:
report = ln.Artifact(
"run_logs.txt",
description=f"Redun run report of {redun_exec['id']}",
run=False,
kind="__lamindb_run__", # mark as auxiliary artifact for the run
).save()
artifact.run.report = report
artifact.run.save()
Show code cell output
Run(uid='dIeMzR5sauXuMiDN', name=None, description=None, entrypoint=None, started_at=2026-10-03 08:34:12 UTC, finished_at=2026-10-03 08:34:32 UTC, params=None, extra_data=None, reference='4ccda618-ed9a-4cc3-87c4-026e1e433677', reference_type='redun_id', cli_args='run workflow.py main --input-dir ./fasta --tag run=test-run', branch_id=1, created_on_id=1, space_id=1, transform_id=1, report_id=8, environment_id=5, plan_id=None, created_by_id=1, initiated_by_run_id=None, created_at=2026-10-03 08:34:12 UTC, is_locked=False)