get_package

View page source

Getting AD Packages

This shell script can be used to install optional AD packages that cmpad can test and compare. These packages are installed locally in the directories build/debug and build/release . These installs can be completely removed by deleting those directories and the external directory.

Syntax

bin/get_package.sh build_type package_1 [ package_2 [ … ] ]
bin/get_package.sh build_type all

build_type

This is either debug or release and determines if C++ and C libraries, built while installing the packages, are debug or release versions.

all

If package_1 is all , all of the possible packages, except clad, fastad and xad (those under construction) are installed. In this case, package_2 … must not be present on the command line.

package_j

The packages package_1 , package_2, … are the list of packages that will be installed. This list must have at least one package ; i.e., package_2 , package_3 , … are optional.

AD Package List

This is the set of AD packages (so far) that can be installed: If one of these packages is not install, it will not be included in the cmpad testing.

AD Package

Implementation

Language

adept

adept_gradient.hpp

cpp

adolc

adolc_gradient.hpp

cpp

autodiff

autodiff_gradient.hpp

cpp

autograd

autograd_gradient.py

python

codi

codi_gradient.hpp

cpp

cppad_jit

cppad_jit_gradient.hpp

cpp

cppad_py

cppad_py_gradient.py

python

cppad

cppad_gradient.hpp

cpp

cppadcg

cppadcg_gradient.hpp

cpp

jax

jax_gradient.py

python

sacado

sacado_gradient.hpp

cpp

torch

torch_gradient.py

python

  1. Implementation is the list of cmpad derivatives implementations so far

  2. Installing adolc also installs colpack.

  3. Installing autodiff or fastad also installs eigen.

  4. Installing cppad or cppad_jit has the same effect.

  5. Installing cppadcg also installs cppad.

Under Construction

AD Package

Language

clad

cpp

fastad

cpp

xad

cpp

external

The source code, and corresponding builds, for all the c++ packages, and the python package cppad_py, is in the top_srcdir/external directory. Thus you can remove the prefix directory and reinstall a new list of packages quickly. If you have trouble with a particular package , and external/package.build_type exists, you may want to try the following:

      rm external/package.build_type
      bin/cpp/get_package build_type package

prefix

The prefixes for the packages installed by bin/get_package.sh is

      top_srcdir / build build_type

This is a python virtual environment created by environment .

Language Specific

The scripts cpp_get_package and py_get_package can be used to get individual C++ and Python AD packages.