Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
carstenbauer committed Aug 7, 2024
1 parent 32ac1d8 commit 1de737a
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/src/examples/ex_distributed.md
Original file line number Diff line number Diff line change
@@ -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).

Expand Down
2 changes: 1 addition & 1 deletion docs/src/examples/ex_mpi.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down

0 comments on commit 1de737a

Please sign in to comment.