Sellar 2

sellar_2

The second discipline of the Sellar problem in JAX.

Classes

JAXSellar2

JAXSellar2(
    n: int = 1,
    k: float = 1.0,
    static_args: Mapping[str, Any] = READ_ONLY_EMPTY_DICT,
    differentiation_method: DifferentiationMethod = AUTO,
    differentiate_at_execution: bool = False,
)

Bases: BaseJAXSellar

The discipline to compute the coupling variable :math:y_2 in JAX.

Parameters:

• k (float, default: 1.0 ) –

  The shared coefficient controlling the coupling strength.

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

def __init__(
    self,
    n: int = 1,
    k: float = 1.0,
    static_args: Mapping[str, Any] = READ_ONLY_EMPTY_DICT,
    differentiation_method: BaseJAXSellar.DifferentiationMethod = BaseJAXSellar.DifferentiationMethod.AUTO,  # noqa: E501
    differentiate_at_execution: bool = False,
) -> None:
    """
    Args:
        k: The shared coefficient controlling the coupling strength.
    """  # noqa: D205, D212, D415
    self.__k = k
    super().__init__(
        n,
        static_args=static_args,
        differentiation_method=differentiation_method,
        differentiate_at_execution=differentiate_at_execution,
    )

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

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

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()