nextmv 0.30.0__py3-none-any.whl → 0.32.0__py3-none-any.whl

nextmv/cloud/batch_experiment.py

@@ -21,6 +21,7 @@ from typing import Any, Optional
 
 from nextmv.base_model import BaseModel
 from nextmv.cloud.input_set import InputSet
+from nextmv.run import Run
 
 
 class ExperimentStatus(str, Enum):
@@ -191,7 +192,10 @@ class BatchExperiment(BatchExperimentInformation):
     instance_ids : list[str]
         List of instance IDs used for the experiment.
     grouped_distributional_summaries : list[dict[str, Any]], optional
-        Grouped distributional summaries of the batch experiment. Defaults to None.
+        Grouped distributional summaries of the batch experiment. Defaults to
+        None.
+    runs : list[Run], optional
+        List of runs in the batch experiment. Defaults to None.
     """
 
     input_set_id: str
@@ -200,6 +204,8 @@ class BatchExperiment(BatchExperimentInformation):
     """List of instance IDs used for the experiment."""
     grouped_distributional_summaries: Optional[list[dict[str, Any]]] = None
     """Grouped distributional summaries of the batch experiment."""
+    runs: Optional[list[Run]] = None
+    """List of runs in the batch experiment."""
 
 
 class BatchExperimentRun(BaseModel):

nextmv/cloud/input_set.py

@@ -14,7 +14,7 @@ from datetime import datetime
 from typing import Optional
 
 from nextmv.base_model import BaseModel
-from nextmv.cloud.run import Format
+from nextmv.run import Format
 
 
 class ManagedInput(BaseModel):

nextmv/cloud/package.py

@@ -10,8 +10,8 @@ import tarfile
 import tempfile
 from typing import Optional
 
-from nextmv.cloud.manifest import MANIFEST_FILE_NAME, Manifest, ManifestBuild, ManifestType
 from nextmv.logger import log
+from nextmv.manifest import MANIFEST_FILE_NAME, Manifest, ManifestBuild, ManifestType
 from nextmv.model import Model, ModelConfiguration, _cleanup_python_model
 
 _MANDATORY_FILES_PER_TYPE = {

nextmv/cloud/url.py

@@ -0,0 +1,73 @@
+"""
+Module for declarations related to upload and download URLs in Nextmv Cloud.
+
+Classes
+-------
+DownloadURL
+    Represents a download URL for fetching content from Nextmv Cloud.
+UploadURL
+    Represents an upload URL for sending content to Nextmv Cloud.
+"""
+
+from nextmv.base_model import BaseModel
+
+
+class DownloadURL(BaseModel):
+    """
+    Result of getting a download URL.
+
+    You can import the `DownloadURL` class directly from `cloud`:
+
+    ```python
+    from nextmv.cloud import DownloadURL
+    ```
+
+    This class represents a download URL that can be used to fetch content
+    from Nextmv Cloud, typically used for downloading large run results.
+
+    Attributes
+    ----------
+    url : str
+        URL to use for downloading the file.
+
+    Examples
+    --------
+    >>> download_url = DownloadURL(url="https://example.com/download")
+    >>> response = requests.get(download_url.url)
+    """
+
+    url: str
+    """URL to use for downloading the file."""
+
+
+class UploadURL(BaseModel):
+    """
+    Result of getting an upload URL.
+
+    You can import the `UploadURL` class directly from `cloud`:
+
+    ```python
+    from nextmv.cloud import UploadURL
+    ```
+
+    This class represents an upload URL that can be used to send data to
+    Nextmv Cloud, typically used for uploading large inputs for runs.
+
+    Attributes
+    ----------
+    upload_id : str
+        ID of the upload, used to reference the uploaded content.
+    upload_url : str
+        URL to use for uploading the file.
+
+    Examples
+    --------
+    >>> upload_url = UploadURL(upload_id="123", upload_url="https://example.com/upload")
+    >>> with open("large_input.json", "rb") as f:
+    ...     requests.put(upload_url.upload_url, data=f)
+    """
+
+    upload_id: str
+    """ID of the upload."""
+    upload_url: str
+    """URL to use for uploading the file."""

nextmv/default_app/.gitignore

@@ -0,0 +1 @@
+.nextmv

nextmv/default_app/README.md

@@ -4,6 +4,7 @@ This is the basic structure of a Nextmv application.
 
 ```text
 ├── app.yaml
+├── main.py
 ├── README.md
 ├── requirements.txt
 └── src
@@ -11,7 +12,21 @@ This is the basic structure of a Nextmv application.
 
 * `app.yaml`: App manifest, containing the configuration to run the app
   remotely on Nextmv Cloud.
+* `main.py`: Entry point for the app.
 * `README.md`: Description of the app.
 * `requirements.txt`: Python dependencies for the app.
-* `src/`: Source code for the app. The `main.py` file is the entry point for
-  the app.
+* `src/`: Source code for the app.
+
+A sample input file is also provided as `input.json`.
+
+1. Install packages.
+
+    ```bash
+    pip3 install -r requirements.txt
+    ```
+
+2. Run the app.
+
+    ```bash
+    cat input.json | python3 main.py
+    ```

nextmv/default_app/app.yaml

@@ -9,3 +9,4 @@ python:
 # (e.g.: configs/*.json) is supported.
 files:
   - src/
+  - main.py

nextmv/default_app/input.json

@@ -0,0 +1,5 @@
+{
+  "name": "Patches",
+  "radius": 6378,
+  "distance": 147.6
+}

nextmv/default_app/main.py

@@ -0,0 +1,37 @@
+from src.visuals import create_visuals
+
+import nextmv
+
+# Read the input from stdin.
+input = nextmv.load()
+name = input.data["name"]
+
+options = nextmv.Options(
+    nextmv.Option("details", bool, True, "Print details to logs. Default true.", False),
+)
+
+##### Insert model here
+
+# Print logs that render in the run view in Nextmv Console.
+message = f"Hello, {name}"
+nextmv.log(message)
+
+if options.details:
+    detail = f"You are {input.data['distance']} million km from the sun"
+    nextmv.log(detail)
+
+assets = create_visuals(name, input.data["radius"], input.data["distance"])
+
+# Write output and statistics.
+output = nextmv.Output(
+    options=options,
+    solution={"message": message},
+    statistics=nextmv.Statistics(
+        result=nextmv.ResultStatistics(
+            value=1.23,
+            custom={"message": message},
+        ),
+    ),
+    assets=assets,
+)
+nextmv.write(output)

nextmv/default_app/src/main.py

@@ -24,7 +24,8 @@ assets = create_visuals(name, input.data["radius"], input.data["distance"])
 
 # Write output and statistics.
 output = nextmv.Output(
-    solution=None,
+    options=options,
+    solution={"message": message},
     statistics=nextmv.Statistics(
         result=nextmv.ResultStatistics(
             value=1.23,

nextmv/input.py

@@ -20,6 +20,11 @@ Functions
 ---------
 load
     Load input data using a specified loader.
+
+Attributes
+----------
+INPUTS_KEY : str
+    Key used for identifying inputs in the run.
 """
 
 import copy
@@ -36,6 +41,11 @@ from nextmv._serialization import serialize_json
 from nextmv.deprecated import deprecated
 from nextmv.options import Options
 
+INPUTS_KEY = "inputs"
+"""
+Inputs key constant used for identifying inputs in the run.
+"""
+
 
 class InputFormat(str, Enum):
     """
@@ -911,7 +921,7 @@ class LocalInputLoader(InputLoader):
             If the path is not a directory or the default directory doesn't exist.
         """
 
-        dir_path = "inputs"
+        dir_path = INPUTS_KEY
         if path is not None and path != "":
             if not os.path.isdir(path):
                 raise ValueError(f"path {path} is not a directory")

nextmv/local/__init__.py

@@ -0,0 +1,5 @@
+"""
+Functionality for locally simulating the Nextmv Cloud.
+"""
+
+from .application import Application as Application