From 59149cd5d931a1a7d0dc08afe424af643bdcfd29 Mon Sep 17 00:00:00 2001 From: pat-alt Date: Wed, 3 Jan 2024 19:11:41 +0100 Subject: [PATCH] update README --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index be42e1f..1667a2d 100644 --- a/README.md +++ b/README.md @@ -6,4 +6,25 @@ [![Coverage](https://codecov.io/gh/JuliaTrustworthyAI/TaijaParallel.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaTrustworthyAI/TaijaParallel.jl) [![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle) -This package adds custom support for parallelization for certain [Taija](https://github.com/JuliaTrustworthyAI) packages. \ No newline at end of file +This package adds custom support for parallelization for certain [Taija](https://github.com/JuliaTrustworthyAI) packages. + +## Installation + +The stable version of this package can be installed as follows: + +``` julia +using Pkg +Pkg.add("TaijaParallel.jl") +``` + +The development version can be installed like so: + +``` julia +using Pkg +Pkg.add("https://github.com/JuliaTrustworthyAI/TaijaParallel.jl") +``` + +## Usage + +Since this package extends the functionality of other Taija packages, it should be used in combination with those packages. For example, see this [tutorial](https://juliatrustworthyai.github.io/CounterfactualExplanations.jl/v0.1/tutorials/parallelization/) to see how `TaijaParallel.jl` can be used with `CounterfactualExplanations.jl`. +