DataChain¶
The DataChain
class creates a data chain, which is a sequence of data manipulation
steps such as reading data from storages, running AI or LLM models or calling external
services API to validate or enrich data. See DataChain
for examples of how to create a chain.
DataChain
¶
DataChain(
query: DatasetQuery,
settings: Settings,
signal_schema: SignalSchema,
setup: Optional[dict] = None,
_sys: bool = False,
)
DataChain - a data structure for batch data processing and evaluation.
It represents a sequence of data manipulation steps such as reading data from storages, running AI or LLM models or calling external services API to validate or enrich data.
Data in DataChain is presented as Python classes with arbitrary set of fields,
including nested classes. The data classes have to inherit from DataModel
class.
The supported set of field types include: majority of the type supported by the
underlyind library Pydantic
.
See Also
DataChain.from_storage("s3://my-bucket/my-dir/")
- reading unstructured
data files from storages such as S3, gs or Azure ADLS.
DataChain.save("name")
- saving to a dataset.
DataChain.from_dataset("name")
- reading from a dataset.
DataChain.from_values(fib=[1, 2, 3, 5, 8])
- generating from values.
DataChain.from_pandas(pd.DataFrame(...))
- generating from pandas.
DataChain.from_json("file.json")
- generating from json.
DataChain.from_csv("file.csv")
- generating from csv.
DataChain.from_parquet("file.parquet")
- generating from parquet.
Example
import os
from mistralai.client import MistralClient
from mistralai.models.chat_completion import ChatMessage
from datachain.dc import DataChain, Column
PROMPT = (
"Was this bot dialog successful? "
"Describe the 'result' as 'Yes' or 'No' in a short JSON"
)
model = "mistral-large-latest"
api_key = os.environ["MISTRAL_API_KEY"]
chain = (
DataChain.from_storage("gs://datachain-demo/chatbot-KiT/")
.limit(5)
.settings(cache=True, parallel=5)
.map(
mistral_response=lambda file: MistralClient(api_key=api_key)
.chat(
model=model,
response_format={"type": "json_object"},
messages=[
ChatMessage(role="user", content=f"{PROMPT}: {file.read()}")
],
)
.choices[0]
.message.content,
)
.save()
)
try:
print(chain.select("mistral_response").results())
except Exception as e:
print(f"do you have the right Mistral API key? {e}")
Source code in datachain/lib/dc.py
__or__
¶
agg
¶
agg(
func: Optional[Callable] = None,
partition_by: Optional[PartitionByType] = None,
params: Union[None, str, Sequence[str]] = None,
output: OutputType = None,
**signal_map
) -> Self
Aggregate rows using partition_by
statement and apply a function to the
groups of aggregated rows. The function needs to return new objects for each
group of the new rows. It returns a chain itself with new signals.
Input-output relationship: N:M
This method bears similarity to gen()
and map()
, employing a comparable set
of parameters, yet differs in two crucial aspects:
1. The partition_by
parameter: This specifies the column name or a list of
column names that determine the grouping criteria for aggregation.
2. Group-based UDF function input: Instead of individual rows, the function
receives a list all rows within each group defined by partition_by
.
Examples:
chain = chain.agg(
total=lambda category, amount: [sum(amount)],
output=float,
partition_by="category",
)
chain.save("new_dataset")
An alternative syntax, when you need to specify a more complex function:
# It automatically resolves which columns to pass to the function
# by looking at the function signature.
def agg_sum(
file: list[File], amount: list[float]
) -> Iterator[tuple[File, float]]:
yield file[0], sum(amount)
chain = chain.agg(
agg_sum,
output={"file": File, "total": float},
# Alternative syntax is to use `C` (short for Column) to specify
# a column name or a nested column, e.g. C("file.path").
partition_by=C("category"),
)
chain.save("new_dataset")
Source code in datachain/lib/dc.py
apply
¶
Apply any function to the chain.
Useful for reusing in a chain of operations.
Example
Source code in datachain/lib/dc.py
batch_map
¶
batch_map(
func: Optional[Callable] = None,
params: Union[None, str, Sequence[str]] = None,
output: OutputType = None,
batch: int = 1000,
**signal_map
) -> Self
This is a batch version of map()
.
Input-output relationship: N:N
It accepts the same parameters plus an additional parameter:
batch : Size of each batch passed to `func`. Defaults to 1000.
Example
Source code in datachain/lib/dc.py
c
¶
Returns Column instance attached to the current chain.
chunk
¶
Split a chain into smaller chunks for e.g. parallelization.
Example
Note
Bear in mind that index
is 0-indexed but total
isn't.
Use 0/3, 1/3 and 2/3, not 1/3, 2/3 and 3/3.
Source code in datachain/lib/dc.py
clone
¶
collect
¶
Yields rows of values, optionally limited to the specified columns.
Parameters:
-
*cols
(str
, default:()
) –Limit to the specified columns. By default, all columns are selected.
Yields:
-
DataType
–Yields a single item if a column is selected.
-
tuple[DataType, ...]
–Yields a tuple of items if multiple columns are selected.
Example
Iterating over all rows:
Iterating over all rows with selected columns:
Iterating over a single column:
Source code in datachain/lib/dc.py
collect_flatten
¶
Yields flattened rows of values as a tuple.
Parameters:
-
row_factory
–A callable to convert row to a custom format. It should accept two arguments: a list of column names and a tuple of row values.
Source code in datachain/lib/dc.py
column
¶
Returns Column instance with a type if name is found in current schema, otherwise raises an exception.
Source code in datachain/lib/dc.py
datasets
classmethod
¶
datasets(
session: Optional[Session] = None,
settings: Optional[dict] = None,
in_memory: bool = False,
object_name: str = "dataset",
include_listing: bool = False,
) -> DataChain
Generate chain with list of registered datasets.
Example
Source code in datachain/lib/dc.py
distinct
¶
Removes duplicate rows based on uniqueness of some input column(s) i.e if rows are found with the same value of input column(s), only one row is left in the result set.
Source code in datachain/lib/dc.py
exec
¶
explode
¶
explode(
col: str,
model_name: Optional[str] = None,
object_name: Optional[str] = None,
schema_sample_size: int = 1,
) -> DataChain
Explodes a column containing JSON objects (dict or str DataChain type) into individual columns based on the schema of the JSON. Schema is inferred from the first row of the column.
Parameters:
-
col
(str
) –the name of the column containing JSON to be exploded.
-
model_name
(Optional[str]
, default:None
) –optional generated model name. By default generates the name automatically.
-
object_name
(Optional[str]
, default:None
) –optional generated object column name. By default generates the name automatically.
-
schema_sample_size
(int
, default:1
) –the number of rows to use for inferring the schema of the JSON (in case some fields are optional and it's not enough to analyze a single row).
Returns:
-
DataChain
(DataChain
) –A new DataChain instance with the new set of columns.
Source code in datachain/lib/dc.py
export_files
¶
export_files(
output: str,
signal="file",
placement: ExportPlacement = "fullpath",
use_cache: bool = True,
) -> None
Method that exports all files from chain to some folder.
Source code in datachain/lib/dc.py
filter
¶
filter(*args: Any) -> Self
Filter the chain according to conditions.
Example
Basic usage with built-in operators
Using glob to match patterns
Using datachain.func
Combining filters with "or"
Combining filters with "and"
Source code in datachain/lib/dc.py
from_csv
classmethod
¶
from_csv(
path,
delimiter: str = ",",
header: bool = True,
output: OutputType = None,
object_name: str = "",
model_name: str = "",
source: bool = True,
nrows=None,
session: Optional[Session] = None,
settings: Optional[dict] = None,
column_types: Optional[
dict[str, Union[str, DataType]]
] = None,
**kwargs
) -> DataChain
Generate chain from csv files.
Parameters:
-
path
–Storage URI with directory. URI must start with storage prefix such as
s3://
,gs://
,az://
or "file:///". -
delimiter
–Character for delimiting columns.
-
header
–Whether the files include a header row.
-
output
–Dictionary or feature class defining column names and their corresponding types. List of column names is also accepted, in which case types will be inferred.
-
object_name
–Created object column name.
-
model_name
–Generated model name.
-
source
–Whether to include info about the source file.
-
nrows
–Optional row limit.
-
session
–Session to use for the chain.
-
settings
–Settings to use for the chain.
-
column_types
–Dictionary of column names and their corresponding types. It is passed to CSV reader and for each column specified type auto inference is disabled.
Example
Reading a csv file:
Reading csv files from a directory as a combined dataset:
Source code in datachain/lib/dc.py
1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 |
|
from_dataset
classmethod
¶
from_dataset(
name: str,
version: Optional[int] = None,
session: Optional[Session] = None,
settings: Optional[dict] = None,
) -> Self
Get data from a saved Dataset. It returns the chain itself.
Parameters:
-
name
–dataset name
-
version
–dataset version
Source code in datachain/lib/dc.py
from_hf
classmethod
¶
from_hf(
dataset: Union[str, HFDatasetType],
*args,
session: Optional[Session] = None,
settings: Optional[dict] = None,
object_name: str = "",
model_name: str = "",
**kwargs
) -> DataChain
Generate chain from huggingface hub dataset.
Parameters:
-
dataset
–Path or name of the dataset to read from Hugging Face Hub, or an instance of
datasets.Dataset
-like object. -
session
–Session to use for the chain.
-
settings
–Settings to use for the chain.
-
object_name
–Generated object column name.
-
model_name
–Generated model name.
-
kwargs
–Parameters to pass to datasets.load_dataset.
Example
Load from Hugging Face Hub:
Generate chain from loaded dataset:
Source code in datachain/lib/dc.py
from_json
classmethod
¶
from_json(
path,
type: Literal["binary", "text", "image"] = "text",
spec: Optional[DataType] = None,
schema_from: Optional[str] = "auto",
jmespath: Optional[str] = None,
object_name: Optional[str] = "",
model_name: Optional[str] = None,
print_schema: Optional[bool] = False,
meta_type: Optional[str] = "json",
nrows=None,
**kwargs
) -> DataChain
Get data from JSON. It returns the chain itself.
Parameters:
-
path
–storage URI with directory. URI must start with storage prefix such as
s3://
,gs://
,az://
or "file:///" -
type
–read file as "binary", "text", or "image" data. Default is "binary".
-
spec
–optional Data Model
-
schema_from
–path to sample to infer spec (if schema not provided)
-
object_name
–generated object column name
-
model_name
–optional generated model name
-
print_schema
–print auto-generated schema
-
jmespath
–optional JMESPATH expression to reduce JSON
-
nrows
–optional row limit for jsonl and JSON arrays
Example
infer JSON schema from data, reduce using JMESPATH
infer JSON schema from a particular path
Source code in datachain/lib/dc.py
from_jsonl
classmethod
¶
from_jsonl(
path,
type: Literal["binary", "text", "image"] = "text",
spec: Optional[DataType] = None,
schema_from: Optional[str] = "auto",
jmespath: Optional[str] = None,
object_name: Optional[str] = "",
model_name: Optional[str] = None,
print_schema: Optional[bool] = False,
meta_type: Optional[str] = "jsonl",
nrows=None,
**kwargs
) -> DataChain
Get data from JSON lines. It returns the chain itself.
Parameters:
-
path
–storage URI with directory. URI must start with storage prefix such as
s3://
,gs://
,az://
or "file:///" -
type
–read file as "binary", "text", or "image" data. Default is "binary".
-
spec
–optional Data Model
-
schema_from
–path to sample to infer spec (if schema not provided)
-
object_name
–generated object column name
-
model_name
–optional generated model name
-
print_schema
–print auto-generated schema
-
jmespath
–optional JMESPATH expression to reduce JSON
-
nrows
–optional row limit for jsonl and JSON arrays
Example
infer JSONl schema from data, limit parsing to 1 row
Source code in datachain/lib/dc.py
from_pandas
classmethod
¶
from_pandas(
df: DataFrame,
name: str = "",
session: Optional[Session] = None,
settings: Optional[dict] = None,
in_memory: bool = False,
object_name: str = "",
) -> DataChain
Generate chain from pandas data-frame.
Source code in datachain/lib/dc.py
from_parquet
classmethod
¶
from_parquet(
path,
partitioning: Any = "hive",
output: Optional[dict[str, DataType]] = None,
object_name: str = "",
model_name: str = "",
source: bool = True,
session: Optional[Session] = None,
settings: Optional[dict] = None,
**kwargs
) -> DataChain
Generate chain from parquet files.
Parameters:
-
path
–Storage URI with directory. URI must start with storage prefix such as
s3://
,gs://
,az://
or "file:///". -
partitioning
–Any pyarrow partitioning schema.
-
output
–Dictionary defining column names and their corresponding types.
-
object_name
–Created object column name.
-
model_name
–Generated model name.
-
source
–Whether to include info about the source file.
-
session
–Session to use for the chain.
-
settings
–Settings to use for the chain.
Example
Reading a single file:
Reading a partitioned dataset from a directory:
Source code in datachain/lib/dc.py
from_records
classmethod
¶
from_records(
to_insert: Optional[Union[dict, list[dict]]],
session: Optional[Session] = None,
settings: Optional[dict] = None,
in_memory: bool = False,
schema: Optional[dict[str, DataType]] = None,
) -> Self
Create a DataChain from the provided records. This method can be used for programmatically generating a chain in contrast of reading data from storages or other sources.
Parameters:
-
to_insert
–records (or a single record) to insert. Each record is a dictionary of signals and theirs values.
-
schema
–describes chain signals and their corresponding types
Source code in datachain/lib/dc.py
2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 |
|
from_storage
classmethod
¶
from_storage(
uri,
*,
type: Literal["binary", "text", "image"] = "binary",
session: Optional[Session] = None,
settings: Optional[dict] = None,
in_memory: bool = False,
recursive: Optional[bool] = True,
object_name: str = "file",
update: bool = False,
anon: bool = False
) -> Self
Get data from a storage as a list of file with all file attributes. It returns the chain itself as usual.
Parameters:
-
uri
–storage URI with directory. URI must start with storage prefix such as
s3://
,gs://
,az://
or "file:///" -
type
–read file as "binary", "text", or "image" data. Default is "binary".
-
recursive
–search recursively for the given path.
-
object_name
–Created object column name.
-
update
–force storage reindexing. Default is False.
-
anon
–If True, we will treat cloud bucket as public one
Source code in datachain/lib/dc.py
from_values
classmethod
¶
from_values(
ds_name: str = "",
session: Optional[Session] = None,
settings: Optional[dict] = None,
in_memory: bool = False,
output: OutputType = None,
object_name: str = "",
**fr_map
) -> DataChain
Generate chain from list of values.
Source code in datachain/lib/dc.py
gen
¶
gen(
func: Optional[Union[Callable, Generator]] = None,
params: Union[None, str, Sequence[str]] = None,
output: OutputType = None,
**signal_map
) -> Self
Apply a function to each row to create new rows (with potentially new signals). The function needs to return a new objects for each of the new rows. It returns a chain itself with new signals.
Input-output relationship: 1:N
This method is similar to map()
, uses the same list of parameters, but with
one key differences: It produces a sequence of rows for each input row (like
extracting multiple file records from a single tar file or bounding boxes from a
single image file).
Example
Source code in datachain/lib/dc.py
group_by
¶
group_by(
*,
partition_by: Optional[
Union[str, Func, Sequence[Union[str, Func]]]
] = None,
**kwargs: Func
) -> Self
Group rows by specified set of signals and return new signals with aggregated values.
The supported functions
count(), sum(), avg(), min(), max(), any_value(), collect(), concat()
Source code in datachain/lib/dc.py
1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 |
|
limit
¶
limit(n: int) -> Self
Return the first n
rows of the chain.
If the chain is unordered, which rows are returned is undefined.
If the chain has less than n
rows, the whole chain is returned.
Parameters:
-
n
(int
) –Number of rows to return.
Source code in datachain/lib/dc.py
listings
classmethod
¶
listings(
session: Optional[Session] = None,
in_memory: bool = False,
object_name: str = "listing",
**kwargs
) -> DataChain
Generate chain with list of cached listings. Listing is a special kind of dataset which has directory listing data of some underlying storage (e.g S3 bucket).
Source code in datachain/lib/dc.py
map
¶
map(
func: Optional[Callable] = None,
params: Union[None, str, Sequence[str]] = None,
output: OutputType = None,
**signal_map
) -> Self
Apply a function to each row to create new signals. The function should return a new object for each row. It returns a chain itself with new signals.
Input-output relationship: 1:1
Parameters:
-
func
–Function applied to each row.
-
params
–List of column names used as input for the function. Default is taken from function signature.
-
output
–Dictionary defining new signals and their corresponding types. Default type is taken from function signature. Default can be also taken from kwargs - **signal_map (see below). If signal name is defined using signal_map (see below) only a single type value can be used.
-
**signal_map
–kwargs can be used to define
func
together with it's return signal name in format ofmap(my_sign=my_func)
. This helps define signal names and function in a nicer way.
Example
Using signal_map and single type in output:
Using func and output as a map:
Source code in datachain/lib/dc.py
merge
¶
merge(
right_ds: DataChain,
on: Union[MergeColType, Sequence[MergeColType]],
right_on: Optional[
Union[MergeColType, Sequence[MergeColType]]
] = None,
inner=False,
rname="right_",
) -> Self
Merge two chains based on the specified criteria.
Parameters:
-
right_ds
(DataChain
) –Chain to join with.
-
on
(Union[MergeColType, Sequence[MergeColType]]
) –Predicate or list of Predicates to join on. If both chains have the same predicates then this predicate is enough for the join. Otherwise,
right_on
parameter has to specify the predicates for the other chain. -
right_on
(Optional[Union[MergeColType, Sequence[MergeColType]]]
, default:None
) –Optional predicate or list of Predicates for the
right_ds
to join. -
inner
(bool
, default:False
) –Whether to run inner join or outer join.
-
rname
(str
, default:'right_'
) –name prefix for conflicting signal names.
Source code in datachain/lib/dc.py
1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 |
|
mutate
¶
Create new signals based on existing signals.
This method cannot modify existing columns. If you need to modify an
existing column, use a different name for the new column and then use
select()
to choose which columns to keep.
This method is vectorized and more efficient compared to map(), and it does not extract or download any data from the internal database. However, it can only utilize predefined built-in functions and their combinations.
The supported functions
Numerical: +, -, *, /, rand(), avg(), count(), func(), greatest(), least(), max(), min(), sum() String: length(), split(), replace(), regexp_replace() Filename: name(), parent(), file_stem(), file_ext() Array: length(), sip_hash_64(), euclidean_distance(), cosine_distance() Window: row_number(), rank(), dense_rank(), first()
Example:
dc.mutate(
area=Column("image.height") * Column("image.width"),
extension=file_ext(Column("file.name")),
dist=cosine_distance(embedding_text, embedding_image)
)
Window function example:
window = func.window(partition_by="file.parent", order_by="file.size")
dc.mutate(
row_number=func.row_number().over(window),
)
This method can be also used to rename signals. If the Column("name") provided as value for the new signal - the old column will be dropped. Otherwise a new column is created.
Example:
Source code in datachain/lib/dc.py
1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 |
|
offset
¶
offset(offset: int) -> Self
Return the results starting with the offset row.
If the chain is unordered, which rows are skipped in undefined.
If the chain has less than offset
rows, the result is an empty chain.
Parameters:
-
offset
(int
) –Number of rows to skip.
Source code in datachain/lib/dc.py
order_by
¶
order_by(*args, descending: bool = False) -> Self
Orders by specified set of columns.
Parameters:
-
descending
(bool
, default:False
) –Whether to sort in descending order or not.
Note
Order is not guaranteed when steps are added after an order_by
statement.
I.e. when using from_dataset
an order_by
statement should be used if
the order of the records in the chain is important.
Using order_by
directly before limit
, collect
and collect_flatten
will give expected results.
See https://github.com/iterative/datachain/issues/477 for further details.
Source code in datachain/lib/dc.py
parse_tabular
¶
parse_tabular(
output: OutputType = None,
object_name: str = "",
model_name: str = "",
source: bool = True,
nrows: Optional[int] = None,
**kwargs
) -> Self
Generate chain from list of tabular files.
Parameters:
-
output
–Dictionary or feature class defining column names and their corresponding types. List of column names is also accepted, in which case types will be inferred.
-
object_name
–Generated object column name.
-
model_name
–Generated model name.
-
source
–Whether to include info about the source file.
-
nrows
–Optional row limit.
-
kwargs
–Parameters to pass to pyarrow.dataset.dataset.
Example
Reading a json lines file:
Reading a filtered list of files as a dataset:
Source code in datachain/lib/dc.py
1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 |
|
parse_uri
classmethod
¶
Returns correct listing dataset name that must be used for saving listing operation. It takes into account existing listings and reusability of those. It also returns boolean saying if returned dataset name is reused / already exists or not, and it returns correct listing path that should be used to find rows based on uri.
Source code in datachain/lib/dc.py
print_json_schema
¶
Print JSON data model and save it. It returns the chain itself.
Parameters:
-
jmespath
–JMESPATH expression to reduce JSON
-
model_name
–generated model name
Example
print JSON schema and save to column "meta_from":
Source code in datachain/lib/dc.py
print_jsonl_schema
¶
Print JSON data model and save it. It returns the chain itself.
Parameters:
-
jmespath
–JMESPATH expression to reduce JSON
-
model_name
–generated model name
Source code in datachain/lib/dc.py
print_schema
¶
sample
¶
Return a random sample from the chain.
Parameters:
-
n
(int
) –Number of samples to draw.
NOTE: Samples are not deterministic, and streamed/paginated queries or multiple workers will draw samples with replacement.
Source code in datachain/lib/dc.py
save
¶
Save to a Dataset. It returns the chain itself.
Parameters:
-
name
–dataset name. Empty name saves to a temporary dataset that will be removed after process ends. Temp dataset are useful for optimization.
-
version
–version of a dataset. Default - the last version that exist.
Source code in datachain/lib/dc.py
select
¶
Select only a specified set of signals.
Source code in datachain/lib/dc.py
select_except
¶
select_except(*args: str) -> Self
Select all the signals expect the specified signals.
Source code in datachain/lib/dc.py
settings
¶
settings(
cache=None,
parallel=None,
workers=None,
min_task_size=None,
prefetch: Optional[int] = None,
sys: Optional[bool] = None,
) -> Self
Change settings for chain.
This function changes specified settings without changing not specified ones. It returns chain, so, it can be chained later with next operation.
Parameters:
-
cache
–data caching (default=False)
-
parallel
–number of thread for processors. True is a special value to enable all available CPUs (default=1)
-
workers
–number of distributed workers. Only for Studio mode. (default=1)
-
min_task_size
–minimum number of tasks (default=1)
-
prefetch
(Optional[int]
, default:None
) –number of workers to use for downloading files in advance. This is enabled by default and uses 2 workers. To disable prefetching, set it to 0.
Example
Source code in datachain/lib/dc.py
setup
¶
Setup variables to pass to UDF functions.
Use before running map/gen/agg/batch_map to save an object and pass it as an argument to the UDF.
Example
import anthropic
from anthropic.types import Message
(
DataChain.from_storage(DATA, type="text")
.settings(parallel=4, cache=True)
.setup(client=lambda: anthropic.Anthropic(api_key=API_KEY))
.map(
claude=lambda client, file: client.messages.create(
model=MODEL,
system=PROMPT,
messages=[{"role": "user", "content": file.get_value()}],
),
output=Message,
)
)
Source code in datachain/lib/dc.py
show
¶
show(
limit: int = 20,
flatten=False,
transpose=False,
truncate=True,
) -> None
Show a preview of the chain results.
Parameters:
-
limit
–How many rows to show.
-
flatten
–Whether to use a multiindex or flatten column names.
-
transpose
–Whether to transpose rows and columns.
-
truncate
–Whether or not to truncate the contents of columns.
Source code in datachain/lib/dc.py
shuffle
¶
subtract
¶
subtract(
other: DataChain,
on: Optional[Union[str, Sequence[str]]] = None,
right_on: Optional[Union[str, Sequence[str]]] = None,
) -> Self
Remove rows that appear in another chain.
Parameters:
-
other
(DataChain
) –chain whose rows will be removed from
self
-
on
(Optional[Union[str, Sequence[str]]]
, default:None
) –columns to consider for determining row equality in
self
. If unspecified, defaults to all common columns betweenself
andother
. -
right_on
(Optional[Union[str, Sequence[str]]]
, default:None
) –columns to consider for determining row equality in
other
. If unspecified, defaults to the same values ason
.
Source code in datachain/lib/dc.py
1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 |
|
to_columnar_data_with_names
¶
to_columnar_data_with_names(
chunk_size: int = DEFAULT_PARQUET_CHUNK_SIZE,
) -> tuple[list[str], Iterator[list[list[Any]]]]
Returns column names and the results as an iterator that provides chunks, with each chunk containing a list of columns, where each column contains a list of the row values for that column in that chunk. Useful for columnar data formats, such as parquet or other OLAP databases.
Source code in datachain/lib/dc.py
to_csv
¶
to_csv(
path: Union[str, PathLike[str]],
delimiter: str = ",",
fs_kwargs: Optional[dict[str, Any]] = None,
**kwargs
) -> None
Save chain to a csv (comma-separated values) file.
Parameters:
-
path
–Path to save the file. This supports local paths as well as remote paths, such as s3:// or hf:// with fsspec.
-
delimiter
–Delimiter to use for the resulting file.
-
fs_kwargs
–Optional kwargs to pass to the fsspec filesystem, used only for write, for fsspec-type URLs, such as s3:// or hf:// when provided as the destination path.
Source code in datachain/lib/dc.py
to_json
¶
to_json(
path: Union[str, PathLike[str]],
fs_kwargs: Optional[dict[str, Any]] = None,
include_outer_list: bool = True,
) -> None
Save chain to a JSON file.
Parameters:
-
path
–Path to save the file. This supports local paths as well as remote paths, such as s3:// or hf:// with fsspec.
-
fs_kwargs
–Optional kwargs to pass to the fsspec filesystem, used only for write, for fsspec-type URLs, such as s3:// or hf:// when provided as the destination path.
-
include_outer_list
–Sets whether to include an outer list for all rows. Setting this to True makes the file valid JSON, while False instead writes in the JSON lines format.
Source code in datachain/lib/dc.py
to_jsonl
¶
Save chain to a JSON lines file.
Parameters:
-
path
–Path to save the file. This supports local paths as well as remote paths, such as s3:// or hf:// with fsspec.
-
fs_kwargs
–Optional kwargs to pass to the fsspec filesystem, used only for write, for fsspec-type URLs, such as s3:// or hf:// when provided as the destination path.
Source code in datachain/lib/dc.py
to_pandas
¶
to_pandas(flatten=False) -> DataFrame
Return a pandas DataFrame from the chain.
Parameters:
-
flatten
–Whether to use a multiindex or flatten column names.
Source code in datachain/lib/dc.py
to_parquet
¶
to_parquet(
path: Union[str, PathLike[str], BinaryIO],
partition_cols: Optional[Sequence[str]] = None,
chunk_size: int = DEFAULT_PARQUET_CHUNK_SIZE,
fs_kwargs: Optional[dict[str, Any]] = None,
**kwargs
) -> None
Save chain to parquet file with SignalSchema metadata.
Parameters:
-
path
–Path or a file-like binary object to save the file. This supports local paths as well as remote paths, such as s3:// or hf:// with fsspec.
-
partition_cols
–Column names by which to partition the dataset.
-
chunk_size
–The chunk size of results to read and convert to columnar data, to avoid running out of memory.
-
fs_kwargs
–Optional kwargs to pass to the fsspec filesystem, used only for write, for fsspec-type URLs, such as s3:// or hf:// when provided as the destination path.
Source code in datachain/lib/dc.py
2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 |
|
to_pytorch
¶
Convert to pytorch dataset format.
Parameters:
-
transform
(Transform
, default:None
) –Torchvision transforms to apply to the dataset.
-
tokenizer
(Callable
, default:None
) –Tokenizer to use to tokenize text values.
-
tokenizer_kwargs
(dict
, default:None
) –Additional kwargs to pass when calling tokenizer.
-
num_samples
(int
, default:0
) –Number of random samples to draw for each epoch. This argument is ignored if
num_samples=0
(the default).
Example
Source code in datachain/lib/dc.py
to_records
¶
Convert every row to a dictionary.
union
¶
Return the set union of the two datasets.
Parameters:
-
other
(Self
) –chain whose rows will be added to
self
.
DataChainError
¶
Session
¶
Session(
name="",
catalog: Optional[Catalog] = None,
client_config: Optional[dict] = None,
in_memory: bool = False,
)
Session is a context that keeps track of temporary DataChain datasets for a proper cleanup. By default, a global session is created.
Temporary or ephemeral datasets are the ones created without specified name. They are useful for optimization purposes and should be automatically removed.
Temp dataset has specific name format
"session_
The
Temp dataset examples
session_myname_624b41_48e8b4 session_4b962d_2a5dff
Parameters:
name (str): The name of the session. Only latters and numbers are supported. It can be empty. catalog (Catalog): Catalog object.
Source code in datachain/query/session.py
get
classmethod
¶
get(
session: Optional[Session] = None,
catalog: Optional[Catalog] = None,
client_config: Optional[dict] = None,
in_memory: bool = False,
) -> Session
Creates a Session() object from a catalog.
Parameters:
-
session
(Session
, default:None
) –Optional Session(). If not provided a new session will be created. It's needed mostly for simple API purposes.
-
catalog
(Catalog
, default:None
) –Optional catalog. By default, a new catalog is created.