Rename to redefine_graph

Author: HCookie

docs/cli/introduction.rst

@@ -19,4 +19,4 @@ The commands are:
 - :ref:`Validate Command <validate-command>`
 - :ref:`Patch Command <patch-command>`
 - :ref:`Requests Command <requests-command>`
-- :ref:`Redefine Command <redefine-command>`
+- :ref:`redefine_graph Command <redefine-command>`

docs/cli/redefine.rst renamed to docs/cli/redefine_graph.rst

@@ -1,7 +1,7 @@
-.. _redefine-command:
+.. _redefine_graph-command:
 
-Redefine Command
-===============
+Redefine Graph Command
+======================
 
 With this command, you can redefine the graph of a checkpoint file.
 This is useful when you want to change / reconfigure the local-domain of a model, or rebuild with a new graph.
@@ -21,7 +21,7 @@ Subcommands allow for a graph to be made from a lat/lon coordinate file, boundin
 
 .. code-block:: bash
 
-    % anemoi-inference redefine --help
+    % anemoi-inference redefine_graph --help
 
     Redefine the graph of a checkpoint file.
 
@@ -49,19 +49,19 @@ Subcommands allow for a graph to be made from a lat/lon coordinate file, boundin
 Examples
 *********
 
-Here are some examples of how to use the `redefine` command:
+Here are some examples of how to use the `redefine_graph` command:
 
 #. Using a graph file:
 
     .. code-block:: bash
 
-          anemoi-inference redefine path/to/checkpoint --graph path/to/graph
+          anemoi-inference redefine_graph path/to/checkpoint --graph path/to/graph
 
 #. Using a graph configuration:
 
     .. code-block:: bash
 
-          anemoi-inference redefine path/to/checkpoint --graph_config path/to/graph_config
+          anemoi-inference redefine_graph path/to/checkpoint --graph_config path/to/graph_config
 
     .. note::
         The configuration of the existing graph can be found using:
@@ -85,19 +85,19 @@ Here are some examples of how to use the `redefine` command:
 
     .. code-block:: bash
 
-          anemoi-inference redefine path/to/checkpoint --latlon path/to/latlon.npy
+          anemoi-inference redefine_graph path/to/checkpoint --latlon path/to/latlon.npy
 
 #. Using bounding box coordinates:
 
     .. code-block:: bash
 
-          anemoi-inference redefine path/to/checkpoint --coords North West South East Resolution
+          anemoi-inference redefine_graph path/to/checkpoint --coords North West South East Resolution
 
     i.e.
 
     .. code-block:: bash
 
-          anemoi-inference redefine path/to/checkpoint --coords 30.0 -10.0 20.0 0.0 0.1/0.1 --global_resolution n320
+          anemoi-inference redefine_graph path/to/checkpoint --coords 30.0 -10.0 20.0 0.0 0.1/0.1 --global_resolution n320
 
 
 All examples can optionally save the updated graph and checkpoint using the `--save-graph` and `--output` options.
@@ -114,7 +114,7 @@ Redefine the checkpoint
 
 .. code-block:: bash
 
-    anemoi-inference redefine path/to/checkpoint --coords 30.0 -10.0 20.0 0.0 0.1/0.1 --global_resolution n320 --save-graph path/to/updated_graph --output path/to/updated_checkpoint
+    anemoi-inference redefine_graph path/to/checkpoint --coords 30.0 -10.0 20.0 0.0 0.1/0.1 --global_resolution n320 --save-graph path/to/updated_graph --output path/to/updated_checkpoint
 
 Create the inference config
 ---------------------------
@@ -157,4 +157,4 @@ Reference
     :module: anemoi.inference.__main__
     :func: create_parser
     :prog: anemoi-inference
-    :path: redefine
+    :path: redefine_graph

docs/index.rst

@@ -153,7 +153,7 @@ You may also have to install pandoc on MacOS:
    cli/inspect
    cli/patch
    cli/requests
-   cli/redefine
+   cli/redefine_graph
 
 .. toctree::
    :maxdepth: 1

src/anemoi/inference/commands/redefine.py renamed to src/anemoi/inference/commands/redefine_graph.py

@@ -52,7 +52,7 @@ def format_namespace_as_str(namespace: Namespace) -> str:
     return " ".join(args)
 
 
-class RedefineCmd(Command):
+class RedefineGraphCmd(Command):
     """Redefine the graph of a checkpoint file."""
 
     def add_arguments(self, command_parser: ArgumentParser) -> None:
@@ -89,19 +89,19 @@ def add_arguments(self, command_parser: ArgumentParser) -> None:
         command_parser.add_argument("--output", type=str, help="Path to save the updated checkpoint.", default=None)
 
     def run(self, args: Namespace) -> None:
-        """Run the redefine command.
+        """Run the redefine_graph command.
 
         Parameters
         ----------
         args : Namespace
             The arguments passed to the command.
         """
-        from anemoi.inference.utils.redefine import create_graph_from_config
-        from anemoi.inference.utils.redefine import get_coordinates_from_file
-        from anemoi.inference.utils.redefine import get_coordinates_from_mars_request
-        from anemoi.inference.utils.redefine import load_graph_from_file
-        from anemoi.inference.utils.redefine import make_graph_from_coordinates
-        from anemoi.inference.utils.redefine import update_checkpoint
+        from anemoi.inference.utils.redefine_graph import create_graph_from_config
+        from anemoi.inference.utils.redefine_graph import get_coordinates_from_file
+        from anemoi.inference.utils.redefine_graph import get_coordinates_from_mars_request
+        from anemoi.inference.utils.redefine_graph import load_graph_from_file
+        from anemoi.inference.utils.redefine_graph import make_graph_from_coordinates
+        from anemoi.inference.utils.redefine_graph import update_checkpoint
 
         check_redefine_imports()
 
@@ -116,7 +116,7 @@ def run(self, args: Namespace) -> None:
 
         # Add command to history
         metadata.setdefault("history", [])
-        metadata["history"].append(f"anemoi-inference redefine {format_namespace_as_str(args)}")
+        metadata["history"].append(f"anemoi-inference redefine_graph {format_namespace_as_str(args)}")
 
         # Create or load the graph
         if args.graph is not None:
@@ -162,4 +162,4 @@ def run(self, args: Namespace) -> None:
         LOG.info("Updated checkpoint saved to %s", model_path)
 
 
-command = RedefineCmd
+command = RedefineGraphCmd

src/anemoi/inference/runners/external_graph.py

@@ -23,7 +23,7 @@
 
 from ..decorators import main_argument
 from ..runners.default import DefaultRunner
-from ..utils.redefine import update_checkpoint
+from ..utils.redefine_graph import update_checkpoint
 from . import runner_registry
 
 LOG = logging.getLogger(__name__)