TaijaParallel
Documentation for TaijaParallel.
TaijaParallel.IsParallel
TaijaParallel.NotParallel
TaijaParallel.ProcessStyle
TaijaParallel.ProcessStyle
TaijaParallel.ProcessStyle
TaijaParallel.ThreadsParallelizer
TaijaBase.parallelize
TaijaBase.parallelize
TaijaParallel.MPIParallelizer
TaijaParallel.chunk_obs
TaijaParallel.split_by_counts
TaijaParallel.split_count
TaijaParallel.split_obs
TaijaParallel.@with_parallelizer
TaijaParallel.IsParallel
— TypeProcesses that can be parallelized have this trait.
TaijaParallel.NotParallel
— TypeBy default all types of have this trait.
TaijaParallel.ProcessStyle
— TypeA base type for a style of process.
TaijaParallel.ProcessStyle
— MethodThe evaluate
function is parallelizable.
TaijaParallel.ProcessStyle
— MethodThe generate_counterfactual
method is parallelizable.
TaijaParallel.ThreadsParallelizer
— TypeThe ThreadsParallelizer
type is used to parallelize the evaluation of a function using Threads.@threads
.
TaijaBase.parallelize
— MethodTaijaBase.parallelize(
+Home · TaijaParallel.jl TaijaParallel
Documentation for TaijaParallel.
TaijaParallel.IsParallel
TaijaParallel.NotParallel
TaijaParallel.ProcessStyle
TaijaParallel.ProcessStyle
TaijaParallel.ProcessStyle
TaijaParallel.ThreadsParallelizer
TaijaBase.parallelize
TaijaBase.parallelize
TaijaParallel.MPIParallelizer
TaijaParallel.chunk_obs
TaijaParallel.split_by_counts
TaijaParallel.split_count
TaijaParallel.split_obs
TaijaParallel.@with_parallelizer
TaijaParallel.IsParallel
— TypeProcesses that can be parallelized have this trait.
sourceTaijaParallel.NotParallel
— TypeBy default all types of have this trait.
sourceTaijaParallel.ProcessStyle
— TypeA base type for a style of process.
sourceTaijaParallel.ProcessStyle
— MethodThe evaluate
function is parallelizable.
sourceTaijaParallel.ProcessStyle
— MethodThe generate_counterfactual
method is parallelizable.
sourceTaijaParallel.ThreadsParallelizer
— TypeThe ThreadsParallelizer
type is used to parallelize the evaluation of a function using Threads.@threads
.
sourceTaijaBase.parallelize
— MethodTaijaBase.parallelize(
parallelizer::ThreadsParallelizer,
f::typeof(CounterfactualExplanations.Evaluation.evaluate),
args...;
kwargs...,
-)
Parallelizes the evaluation of f
using Threads.@threads
. This function is used to evaluate counterfactual explanations.
sourceTaijaBase.parallelize
— MethodTaijaBase.parallelize(
+)
Parallelizes the evaluation of f
using Threads.@threads
. This function is used to evaluate counterfactual explanations.
sourceTaijaBase.parallelize
— MethodTaijaBase.parallelize(
parallelizer::ThreadsParallelizer,
f::typeof(CounterfactualExplanations.generate_counterfactual),
args...;
kwargs...,
-)
Parallelizes the evaluation of f
using Threads.@threads
. This function is used to generate counterfactual explanations.
sourceTaijaParallel.MPIParallelizer
— FunctionMPIParallelizer
Exposes the MPIParallelizer
function from the MPIExt
extension.
sourceTaijaParallel.chunk_obs
— Methodchunk_obs(obs::AbstractVector, n_each::Integer, n_groups::Integer)
Split the vector of observations obs
into chunks such that each chunk has n_each
observations for each available CPU core (i.e. n_groups
).
sourceTaijaParallel.split_by_counts
— Methodsplit_by_counts(obs::AbstractVector, counts::AbstractVector)
Return a vector of vectors of obs
split by counts
.
sourceTaijaParallel.split_count
— Methodsplit_count(N::Integer, n::Integer)
Return a vector of n
integers which are approximately equally sized and sum to N
. Lifted from https://juliaparallel.org/MPI.jl/v0.20/examples/06-scatterv/.
sourceTaijaParallel.split_obs
— Methodsplit_obs(obs::AbstractVector, n::Integer)
Return a vector of n
group indices for obs
.
sourceTaijaParallel.@with_parallelizer
— Macro@with_parallelizer(parallelizer, expr)
This macro can be used to parallelize a function call or block of code. The macro will check that the function is parallelizable and then call parallelize
with the supplied parallelizer
and expr
.
sourceSettings
This document was generated with Documenter.jl version 1.3.0 on Monday 8 April 2024. Using Julia version 1.10.2.
+)
Parallelizes the evaluation of f
using Threads.@threads
. This function is used to generate counterfactual explanations.
TaijaParallel.MPIParallelizer
— FunctionMPIParallelizer
Exposes the MPIParallelizer
function from the MPIExt
extension.
TaijaParallel.chunk_obs
— Methodchunk_obs(obs::AbstractVector, n_each::Integer, n_groups::Integer)
Split the vector of observations obs
into chunks such that each chunk has n_each
observations for each available CPU core (i.e. n_groups
).
TaijaParallel.split_by_counts
— Methodsplit_by_counts(obs::AbstractVector, counts::AbstractVector)
Return a vector of vectors of obs
split by counts
.
TaijaParallel.split_count
— Methodsplit_count(N::Integer, n::Integer)
Return a vector of n
integers which are approximately equally sized and sum to N
. Lifted from https://juliaparallel.org/MPI.jl/v0.20/examples/06-scatterv/.
TaijaParallel.split_obs
— Methodsplit_obs(obs::AbstractVector, n::Integer)
Return a vector of n
group indices for obs
.
TaijaParallel.@with_parallelizer
— Macro@with_parallelizer(parallelizer, expr)
This macro can be used to parallelize a function call or block of code. The macro will check that the function is parallelizable and then call parallelize
with the supplied parallelizer
and expr
.