Skip to content

Rename constructors to recipes #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
santisoler merged 2 commits into from
Oct 27, 2025
Merged

Rename constructors to recipes #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a174f7
Rename recipe function
santisoler Oct 24, 2025
5f94c28
Update notebooks
santisoler Oct 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion notebooks/09_inversion-with-constructor.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@
"chi_target = 1.0\n",
"initial_model = np.zeros(n_params)\n",
"\n",
"inversion = ii.create_inversion(\n",
"inversion = ii.create_l2_inversion(\n",
" data_misfit,\n",
" smallness,\n",
" starting_beta=starting_beta,\n",
Expand Down
2 changes: 1 addition & 1 deletion notebooks/12_gravity-inversion-with-constructor.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -464,7 +464,7 @@
"source": [
"initial_model = np.zeros(simulation.n_params)\n",
"\n",
"inversion = ii.create_inversion(\n",
"inversion = ii.create_l2_inversion(\n",
" data_misfit,\n",
" smallness,\n",
" starting_beta=1e6,\n",
Expand Down
4 changes: 2 additions & 2 deletions src/inversion_ideas/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
from . import base, typing, utils
from ._version import __version__
from .conditions import ChiTarget, CustomCondition, ModelChanged, ObjectiveChanged
from .constructors import create_inversion, create_sparse_inversion
from .data_misfit import DataMisfit
from .directives import (
Irls,
Expand All @@ -17,6 +16,7 @@
from .inversion_log import InversionLog, InversionLogRich
from .minimize import GaussNewtonConjugateGradient, conjugate_gradient
from .preconditioners import JacobiPreconditioner, get_jacobi_preconditioner
from .recipes import create_l2_inversion, create_sparse_inversion
from .regularization import Flatness, Smallness, SparseSmallness, TikhonovZero
from .simulations import wrap_simulation

Expand All @@ -42,7 +42,7 @@
"__version__",
"base",
"conjugate_gradient",
"create_inversion",
"create_l2_inversion",
"create_sparse_inversion",
"get_jacobi_preconditioner",
"typing",
Expand Down
4 changes: 2 additions & 2 deletions src/inversion_ideas/constructors.py → src/inversion_ideas/recipes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Functions to easily build commonly used objects in inversions.
Recipe functions to easily build commonly used inversions.
"""

from collections.abc import Callable
Expand All @@ -14,7 +14,7 @@
from .typing import Model, Preconditioner


def create_inversion(
def create_l2_inversion(
data_misfit: Objective,
model_norm: Objective,
*,
Expand Down