search

laminlabs / lamindb

A data framework for biology.
https://docs.lamin.ai
Apache License 2.0
126 stars 10 forks source link

📝 Improve the "Lamin Process" graphic of the API #2068

Open falexwolf opened 5 days ago

falexwolf commented 5 days ago

Ref: https://lamin.ai/laminlabs/lamin-site-assets/artifact/BunYmHkyFLITlM5MYQTN

image

I think it's been a great graphic for a year, but we can improve. This issue collects suggestions for improving it.

falexwolf commented 5 days ago

Simple things:

  1. We should add .get()
  2. We should rename .backed() to .open()
  3. We should eliminate .from_values() and add Curator
  4. We should eliminate "Register" and call it "Save" saying "Save output data in registries". We might want to call out .save() and curator.save_artifact() because these are the two fundamental ways of saving plain & annotated output data.

The word "access"

Rather than calling it "Access", we could call it "Query" if we wanted to more immediately convey that Lamin allows queries rather than more naive forms of access.

The issue is that often times, with query we mean .get() and .filter(); and .search() and .open() on an array with subsequent subsetting are referred to as "search" and "slicing".

The word "track the process"

One could say "Iterate" instead so that it's clear that you're supposed to go "round & round" many times. Because the function is called "track()", this might be clear already.