Skip to content

README.md

Latest commit

 

History

History
55 lines (39 loc) · 3.08 KB

README.md

File metadata and controls

55 lines (39 loc) · 3.08 KB

DifferentiationInterfaceTest

Build Status Coverage Code Style: Blue ColPrac: Contributor's Guide on Collaborative Practices for Community Packages DOI

Package Docs
DifferentiationInterface Stable Dev
DifferentiationInterfaceTest Stable Dev

Testing and benchmarking utilities for automatic differentiation (AD) in Julia, based on DifferentiationInterface.

Goal

Make it easy to know, for a given function:

  • which AD backends can differentiate it
  • how fast they can do it

Features

  • Definition of custom test scenarios
  • Correctness tests
  • Type stability tests
  • Count calls to the function
  • Benchmark runtime and allocations

Installation

To install the stable version of the package, run the following code in a Julia REPL:

using Pkg

Pkg.add("DifferentiationInterfaceTest")

To install the development version, run this instead:

using Pkg

Pkg.add(
    url="https://github.com/JuliaDiff/DifferentiationInterface.jl",
    subdir="DifferentiationInterface"
)

Pkg.add(
    url="https://github.com/JuliaDiff/DifferentiationInterface.jl",
    subdir="DifferentiationInterfaceTest"
)