Skip to content

Commit

Permalink
Tweak/fix README (#21)
Browse files Browse the repository at this point in the history
  • Loading branch information
tkf authored Oct 12, 2020
1 parent e026e7b commit e269800
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,20 @@ FoldsCUDA.jl provides
[Transducers.jl](https://github.com/JuliaFolds/Transducers.jl)-compatible
fold (reduce) implemented using
[CUDA.jl](https://github.com/JuliaGPU/CUDA.jl). This brings the
transducers and monoid combinators implemented in Transducers.jl to
GPU. Furthermore, using
[FLoops.jl](https://github.com/JuliaFolds/FLoops.jl), you can run
write parallel `for` loops that run on GPU.
transducers and reducing function combinators implemented in
Transducers.jl to GPU. Furthermore, using
[FLoops.jl](https://github.com/JuliaFolds/FLoops.jl), you can write
parallel `for` loops that run on GPU.

## API

* `foldx_cuda`: a GPU equivalent of parallel extended fold
[`Transducers.foldxt`](https://juliafolds.github.io/Transducers.jl/dev/reference/manual/#Transducers.foldxt).
* `CUDAEx`: a parallel loop executor for FLoops.jl.

See the documentation of Transducers.jl and FLoops.jl for more
See the documentation of
[Transducers.jl](https://juliafolds.github.io/Transducers.jl/dev/) and
[FLoops.jl](https://juliafolds.github.io/FLoops.jl/dev/) for more
information.

## Examples
Expand Down

2 comments on commit e269800

@tkf
Copy link
Member Author

@tkf tkf commented on e269800 Oct 12, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request updated: JuliaRegistries/General/22842

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.1.0 -m "<description of version>" e2698000b60b35fa40d51810a4b42a36819a3824
git push origin v0.1.0

Please sign in to comment.