plugins.plugin.Plugin

plugins.plugin.Plugin()

The interface every cadjoint plugin satisfies.

Attributes

Name Description
capabilities What this plugin declares it can do.
inputs The declared inputs, as the runtime publishes them.
outputs The declared outputs, as the runtime publishes them.

Methods

Name Description
apply Evaluate the component on concrete arrays.
as_jax A JAX-traceable inputs -> outputs callable for this plugin.
probe Check the instance is up and is the one the spec expects.
vjp Pull a cotangent back onto the requested inputs.

apply

plugins.plugin.Plugin.apply(inputs=None, **kwargs)

Evaluate the component on concrete arrays.

as_jax

plugins.plugin.Plugin.as_jax()

A JAX-traceable inputs -> outputs callable for this plugin.

probe

plugins.plugin.Plugin.probe()

Check the instance is up and is the one the spec expects.

vjp

plugins.plugin.Plugin.vjp(inputs, vjp_inputs, vjp_outputs, cotangent_vector)

Pull a cotangent back onto the requested inputs.