Skip to content

Commit 8d59e9f

Browse files
authored
Merge pull request #541 from m-fila/datateps_docs
Include datadeps in API documentation
2 parents 235b968 + 88d723e commit 8d59e9f

File tree

3 files changed

+17
-2
lines changed

3 files changed

+17
-2
lines changed

Diff for: docs/src/api-dagger/functions.md

+5
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,11 @@ mutable
3030
shard
3131
```
3232

33+
## Data Dependencies Functions
34+
```@docs
35+
spawn_datadeps
36+
```
37+
3338
## Scope Functions
3439
```@docs
3540
scope

Diff for: docs/src/api-dagger/types.md

+8
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,14 @@ Chunk
2626
Shard
2727
```
2828

29+
## Data Dependencies Types
30+
```@docs
31+
In
32+
Out
33+
InOut
34+
Deps
35+
```
36+
2937
## Processor Types
3038
```@docs
3139
Processor

Diff for: docs/src/datadeps.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,10 @@ linear algebra) hard to express efficiently in Dagger. Thankfully, there is a
66
solution called "Datadeps" (short for "data dependencies"), accessible through
77
the `spawn_datadeps` function. This function constructs a "datadeps region",
88
within which tasks are allowed to write to their arguments, with parallelism
9-
controlled via dependencies specified via argument annotations. Let's look at a
10-
simple example to make things concrete:
9+
controlled via dependencies specified via argument annotations. At the end of
10+
the "datadeps region" the `spawn_datadeps` will wait for the completion of all
11+
the tasks launched within it. Let's look at a simple example to make things
12+
concrete:
1113

1214
```julia
1315
A = rand(1000)

0 commit comments

Comments
 (0)