Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: reorganize docs (update sql-> func) #844

Merged
merged 3 commits into from
Jan 31, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/references/func.md
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion docs/references/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
18 changes: 0 additions & 18 deletions docs/references/sql.md

This file was deleted.

2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down