diff --git a/docs/src/api-dagger/functions.md b/docs/src/api-dagger/functions.md index 57d16e14b..298734514 100644 --- a/docs/src/api-dagger/functions.md +++ b/docs/src/api-dagger/functions.md @@ -59,6 +59,11 @@ addprocs! rmprocs! ``` +## Distributed Package Selection Functions +```@docs +set_distributed_package! +``` + ## DTask Execution Environment Functions These functions are used within the function called by a `DTask`. diff --git a/docs/src/index.md b/docs/src/index.md index b408eb129..f98e715c1 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -304,6 +304,24 @@ data on disk to be specified as desired. ----- +## Quickstart: Distributed Package Selection + +Dagger.jl can use either the built-in `Distributed` package or the `DistributedNext` package for distributed operations. You can set your preference using the `Dagger.set_distributed_package!` function. + +### Setting the Distributed Package + +To set your preferred distributed package (e.g., to `DistributedNext`): + +```julia +Dagger.set_distributed_package!("DistributedNext") +``` + +This will set a preference that persists across Julia sessions. Remember that **you need to restart your Julia session** for this change to take effect. + +For more details, see [`Dagger.set_distributed_package!`](@ref). + +----- + ## Quickstart: Distributed Arrays Dagger's `DArray` type represents a distributed array, where a single large