Sellar chain

sellar_chain

Chain of the three disciplines of the Sellar problem in JAX.

Classes

JAXSellarChain

JAXSellarChain(
    n: int = 1,
    k: float = 1.0,
    pre_run: bool = True,
    **kwargs: Any
)

Bases: JAXChain

Chain of the three disciplines of the Sellar problem in JAX.

Initialize the JAXDiscipline.

Parameters:

• n (int, default: 1 ) –

  The description is missing.

• k (float, default: 1.0 ) –

  The description is missing.

• pre_run (bool, default: True ) –

  Whether to pre run the jit.

• **kwargs (Any, default: {} ) –

  The arguments passed to JAXChain.

Source code in src/gemseo_jax/problems/sellar/sellar_chain.py

def __init__(
    self, n: int = 1, k: float = 1.0, pre_run: bool = True, **kwargs: Any
) -> None:
    """
    Args:
        pre_run: Whether to pre run the jit.
        **kwargs: The arguments passed to JAXChain.
    """  # noqa: D205  D212 D415
    disciplines = [
        JAXSellar1(n=n, k=k),
        JAXSellar2(n=n, k=k),
        JAXSellarSystem(n=n),
    ]
    super().__init__(disciplines, **kwargs)
    self.add_differentiated_outputs([OBJ, C_1, C_2])
    self.compile_jit(pre_run=pre_run)

Attributes

jax_out_func instance-attribute

jax_out_func: Callable[[DataType], DataType] = function

The JAX function to compute the outputs from the inputs.

Classes

DifferentiationMethod

Bases: StrEnum

The method to compute the Jacobian.

Functions

add_differentiated_inputs

add_differentiated_inputs(
    input_names: Iterable[str] = (),
) -> None

Add the inputs with respect to which to differentiate the outputs.

The inputs that do not represent continuous numbers are filtered out.

Parameters:

• input_names (Iterable[str], default: () ) –

  The input variables with respect to which to differentiate the outputs. If empty, use all the inputs.

Raises:

• ValueError –

  When an input name is not the name of a discipline input.

Notes

The Jacobian is also filtered to view non-differentiated static.

Source code in src/gemseo_jax/jax_discipline.py

def add_differentiated_inputs(
    self,
    input_names: Iterable[str] = (),
) -> None:
    """
    Notes:
        The Jacobian is also filtered to view non-differentiated static.
    """  # noqa: D205, D212, D415
    old_differentiated_inputs = self._differentiated_input_names.copy()
    super().add_differentiated_inputs(input_names=input_names)
    refilter = any(
        input_name not in old_differentiated_inputs
        for input_name in self._differentiated_input_names
    )
    if refilter:
        self._filter_jacobian()

add_differentiated_outputs

add_differentiated_outputs(
    output_names: Iterable[str] = (),
) -> None

Add the outputs to be differentiated.

The outputs that do not represent continuous numbers are filtered out.

Parameters:

• output_names (Iterable[str], default: () ) –

  The outputs to be differentiated. If empty, use all the outputs.

Raises:

• ValueError –

  When an output name is not the name of a discipline output.

Notes

The Jacobian is also filtered to view non-differentiated static.

Source code in src/gemseo_jax/jax_discipline.py

def add_differentiated_outputs(
    self,
    output_names: Iterable[str] = (),
) -> None:
    """
    Notes:
        The Jacobian is also filtered to view non-differentiated static.
    """  # noqa: D205, D212, D415
    old_differentiated_outputs = self._differentiated_output_names.copy()
    super().add_differentiated_outputs(output_names=output_names)
    refilter = any(
        output_name not in old_differentiated_outputs
        for output_name in self._differentiated_output_names
    )
    if refilter:
        self._filter_jacobian()

compile_jit

compile_jit(pre_run: bool = True) -> None

Apply jit compilation over function and jacobian.

Parameters:

• pre_run (bool, default: True ) –

  Whether to call jitted callables once to trigger compilation and log times.

Warning

Calling add_differentiated_inputs and add_differentiated_outputs must be done before calling compile_jit.

Source code in src/gemseo_jax/jax_discipline.py

def compile_jit(
    self,
    pre_run: bool = True,
) -> None:
    """Apply jit compilation over function and jacobian.

    Args:
        pre_run: Whether to call jitted callables once to trigger compilation and
            log times.

    Warning:
        Calling
        [add_differentiated_inputs][gemseo_jax.jax_discipline.JAXDiscipline.add_differentiated_inputs]
        and
        [add_differentiated_outputs][gemseo_jax.jax_discipline.JAXDiscipline.add_differentiated_outputs]
        must be done before calling
        [compile_jit][gemseo_jax.jax_discipline.JAXDiscipline.compile_jit].
    """
    self.jax_out_func = jit(self.jax_out_func)
    self.__jax_jac_func = jit(self.__jax_jac_func)
    if pre_run:
        self._jit_pre_run()