diff --git a/docs/src/examples/ex_distributed.md b/docs/src/examples/ex_distributed.md index 83dd0d06..c9de4d39 100644 --- a/docs/src/examples/ex_distributed.md +++ b/docs/src/examples/ex_distributed.md @@ -1,4 +1,4 @@ -# Distributed.jl + Threads +# [Distributed.jl + Threads](@id distributed_threads) ThreadPinning.jl has dedicated support for pinning Julia threads of Julia workers (Distributed.jl) in multi-processing applications, see [Querying - Distributed.jl](@ref api_distributed_querying) and [Pinning - Distributed.jl](@ref api_distributed_pinning). Note that you can use these tools irrespective of whether your parallel application is pure (i.e. each Julia workers runs a single Julia thread) or hybrid (i.e. each Julia worker runs multiple Julia threads). diff --git a/docs/src/examples/ex_mpi.md b/docs/src/examples/ex_mpi.md index 28f8e8b8..c4c3ef09 100644 --- a/docs/src/examples/ex_mpi.md +++ b/docs/src/examples/ex_mpi.md @@ -1,4 +1,4 @@ -# MPI + Threads +# [MPI + Threads](@id mpi_threads) ThreadPinning.jl has dedicated support for pinning Julia threads of MPI ranks in MPI applications, see [Querying - MPI](@ref api_mpi_querying) and [Pinning - MPI](@ref api_mpi_pinning). Note that you can use these tools irrespective of whether your MPI applications is pure (i.e. each MPI rank runs a single Julia thread) or hybrid (i.e. each MPI ranks runs multiple Julia threads). We demonstrate this with a simple example below. diff --git a/docs/src/index.md b/docs/src/index.md index fa38b2b7..7d2a66c5 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -5,7 +5,7 @@ Most notably, [ThreadPinning.jl](https://github.com/carstenbauer/ThreadPinning.j * to pin Julia threads to specific CPU-threads ("hardware threads") with [`pinthreads`](@ref pinthreads) and * to obtain a visual overview of the system topology with [`threadinfo`](@ref threadinfo). -There is dedicated support for pinning Julia threads in distributed Julia applications that use MPI.jl or Distributed.jl. +There is dedicated support for pinning Julia threads in hybrid Julia applications ([MPI + Threads](@ref mpi_threads) or [Distributed.jl + Threads](@ref distributed_threads)). ## What is this about? (10 minutes)