Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
pat-alt committed Jan 3, 2024
1 parent 340fa60 commit 59149cd
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
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`.

0 comments on commit 59149cd

Please sign in to comment.