diff --git a/docs/references/func.md b/docs/references/func.md new file mode 100644 index 000000000..99e5378e0 --- /dev/null +++ b/docs/references/func.md @@ -0,0 +1,5 @@ +# Functions + +Use built-in functions for data manipulation and analysis to operate on the underlying database storing the chain data. These functions are useful for operations like [`DataChain.filter`](datachain.md#datachain.lib.dc.DataChain.filter) and [`DataChain.mutate`](datachain.md#datachain.lib.dc.DataChain.mutate). Import these functions from `datachain.func`. + +::: datachain.func diff --git a/docs/references/index.md b/docs/references/index.md index 1704524ef..5eece1253 100644 --- a/docs/references/index.md +++ b/docs/references/index.md @@ -10,5 +10,5 @@ DataChain's API is organized into several modules: - [DataType](./datatype.md) - Type system and schema definitions - [File](./file.md) - File handling and storage operations - [UDF](./udf.md) - User-defined functions and transformations -- [SQL](./sql.md) - SQL query integration +- [Functions](./func.md) - Built-in functions for data manipulation and analysis - [Torch](./torch.md) - PyTorch data loading utilities diff --git a/docs/references/sql.md b/docs/references/sql.md deleted file mode 100644 index ddf663993..000000000 --- a/docs/references/sql.md +++ /dev/null @@ -1,18 +0,0 @@ -# SQL - -Use SQL functions to operate on the underlying database storing the chain data. Useful -for operations like [`DataChain.filter`](datachain.md#datachain.lib.dc.DataChain.filter) - and [`DataChain.mutate`](datachain.md#datachain.lib.dc.DataChain.mutate). Import - these functions from `datachain.sql.functions`. - -::: datachain.func.avg -::: datachain.func.count -::: datachain.func.greatest -::: datachain.func.least -::: datachain.func.max -::: datachain.func.min -::: datachain.func.rand -::: datachain.func.sum -::: datachain.func.array -::: datachain.func.path -::: datachain.func.string diff --git a/mkdocs.yml b/mkdocs.yml index 8e7d47ac1..2917a15bd 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -73,7 +73,7 @@ nav: - File: references/file.md - UDF: references/udf.md - Torch: references/torch.md - - SQL: references/sql.md + - Functions: references/func.md - 🤝 Contributing: contributing.md - DataChain Website ↗: https://datachain.ai" target="_blank"