Skip to content

Include datadeps in API documentation #541

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

Merged
merged 1 commit into from
Jul 7, 2024
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/src/api-dagger/functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ mutable
shard
```

## Data Dependencies Functions
```@docs
spawn_datadeps
```

## Scope Functions
```@docs
scope
Expand Down
8 changes: 8 additions & 0 deletions docs/src/api-dagger/types.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,14 @@ Chunk
Shard
```

## Data Dependencies Types
```@docs
In
Out
InOut
Deps
```

## Processor Types
```@docs
Processor
Expand Down
6 changes: 4 additions & 2 deletions docs/src/datadeps.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@ linear algebra) hard to express efficiently in Dagger. Thankfully, there is a
solution called "Datadeps" (short for "data dependencies"), accessible through
the `spawn_datadeps` function. This function constructs a "datadeps region",
within which tasks are allowed to write to their arguments, with parallelism
controlled via dependencies specified via argument annotations. Let's look at a
simple example to make things concrete:
controlled via dependencies specified via argument annotations. At the end of
the "datadeps region" the `spawn_datadeps` will wait for the completion of all
the tasks launched within it. Let's look at a simple example to make things
concrete:

```julia
A = rand(1000)
Expand Down