Merge pull request #188 from runpod/1.3.1-changelog

1.3.1 changelog

Author: justinmerrell

CHANGELOG.md

@@ -1,16 +1,18 @@
 # Change Log
 
-## Release 1.3.1 (TBD)
+## Release 1.3.1 (10/29/23)
 
 ### Added
 
 - `test_output` can be passed in as an arg to compare the results of `test_input`
 - Generator/Streaming handlers supported with local testing
 - [BETA] CLI DevEx functionality to create development projects.
 
+---
+
 ## Release 1.3.0 (10/12/23)
 
-### Changes
+### Changed
 
 - Backwards compatibility with Python >= 3.8
 - Consolidated install dependencies to `requirements.txt`
@@ -23,7 +25,7 @@
 
 ## Release 1.2.6 (10/6/23)
 
-### Changes
+### Changed
 
 - Force `urllib3` logging to `WARNING` level to avoid spamming the console if global logging level is set to `DEBUG`.
 
@@ -40,7 +42,7 @@
 
 ## ~~Release (Patch) 1.2.3 (10/4/23)~~ Replaced by 1.2.5
 
-### Bug Fix
+### Fixed
 
 - Job outputs that were not dictionaries, bool, or str were swallowed by the serverless worker. This has been fixed.
 
@@ -55,7 +57,7 @@
 - `network_volume_id` can now be passed in when creating new pods, correct data center is automatically selected.
 - `template_id` can now be passed in when creating new pods.
 
-### Changes
+### Changed
 
 - Dependencies updated to latest versions.
 - Reduced circular imports for version reference.
@@ -91,7 +93,7 @@
 - Can generate a credentials file from the CLI to store your API key.
 - `get_gpu` now supports `gpu_quantity` as a parameter.
 
-### Changes
+### Changed
 
 - Minimized the use of pytests in favor of unittests.
 - Re-named `api_wrapper` to `api` for consistency.

docs/cli/demos/config.gif

@@ -0,0 +1,30 @@
+""" Example of creating an endpoint with the Runpod API. """
+
+import runpod
+
+# Set your global API key with `runpod config` or uncomment the line below:
+# runpod.api_key = "YOUR_RUNPOD_API_KEY"
+
+try:
+
+    new_template = runpod.create_template(
+        name="test",
+        image_name="runpod/base:0.1.0",
+        is_serverless=True
+    )
+
+    print(new_template)
+
+    new_endpoint = runpod.create_endpoint(
+        name="test",
+        template_id=new_template["id"],
+        gpu_ids="AMPERE_16",
+        workers_min=0,
+        workers_max=1
+    )
+
+    print(new_endpoint)
+
+except runpod.error.QueryError as err:
+    print(err)
+    print(err.query)

docs/cli/demos/help.gif

@@ -0,0 +1,19 @@
+""" Example of creating a template with the Runpod API. """
+
+import runpod
+
+# Set your global API key with `runpod config` or uncomment the line below:
+# runpod.api_key = "YOUR_RUNPOD_API_KEY"
+
+try:
+
+    new_template = runpod.create_template(
+        name="test",
+        image_name="runpod/base:0.1.0"
+    )
+
+    print(new_template)
+
+except runpod.error.QueryError as err:
+    print(err)
+    print(err.query)

docs/cli/demos/ssh.gif

@@ -9,9 +9,10 @@
 from .version import __version__
 from .api.ctl_commands import(
     get_user, update_user_settings,
-    get_gpus, get_gpu,
-    get_pods, get_pod,
-    create_pod, stop_pod, resume_pod, terminate_pod
+    get_gpu, get_gpus,
+    get_pod, get_pods, create_pod, stop_pod, resume_pod, terminate_pod,
+    create_template,
+    create_endpoint
 )
 from .cli.groups.config.functions import set_credentials, check_credentials, get_credentials
 

examples/api/create_endpoint.py

@@ -11,6 +11,10 @@
 from .queries import pods as pod_queries
 from .graphql import run_graphql_query
 from .mutations import pods as pod_mutations
+from .mutations import endpoints as endpoint_mutations
+
+# Templates
+from .mutations import templates as template_mutations
 
 def get_user() -> dict:
     '''
@@ -188,3 +192,73 @@ def terminate_pod(pod_id: str):
     run_graphql_query(
         pod_mutations.generate_pod_terminate_mutation(pod_id)
     )
+
+
+def create_template(
+        name:str, image_name:str, docker_start_cmd:str=None,
+        container_disk_in_gb:int=10, volume_in_gb:int=None, volume_mount_path:str=None,
+        ports:str=None, env:dict=None, is_serverless:bool=False
+):
+    '''
+    Create a template
+
+    :param name: the name of the template
+    :param image_name: the name of the docker image to be used by the template
+    :param docker_start_cmd: the command to start the docker container with
+    :param container_disk_in_gb: how big should the container disk be
+    :param volume_in_gb: how big should the volume be
+    :param ports: the ports to open in the pod, example format - "8888/http,666/tcp"
+    :param volume_mount_path: where to mount the volume?
+    :param env: the environment variables to inject into the pod,
+                for example {EXAMPLE_VAR:"example_value", EXAMPLE_VAR2:"example_value 2"}, will
+                inject EXAMPLE_VAR and EXAMPLE_VAR2 into the pod with the mentioned values
+    :param is_serverless: is the template serverless?
+
+    :example:
+
+    >>> template_id = runpod.create_template("test", "runpod/stack", "python3 main.py")
+    '''
+    raw_response = run_graphql_query(
+        template_mutations.generate_pod_template(
+            name, image_name, docker_start_cmd,
+            container_disk_in_gb, volume_in_gb, volume_mount_path,
+            ports, env, is_serverless
+        )
+    )
+
+    return raw_response["data"]["saveTemplate"]
+
+def create_endpoint(
+        name:str, template_id:str, gpu_ids:str="AMPERE_16",
+        network_volume_id:str=None, locations:str=None,
+        idle_timeout:int=5, scaler_type:str="QUEUE_DELAY", scaler_value:int=4,
+        workers_min:int=0, workers_max:int=3
+):
+    '''
+    Create an endpoint
+
+    :param name: the name of the endpoint
+    :param template_id: the id of the template to use for the endpoint
+    :param gpu_ids: the ids of the GPUs to use for the endpoint
+    :param network_volume_id: the id of the network volume to use for the endpoint
+    :param locations: the locations to use for the endpoint
+    :param idle_timeout: the idle timeout for the endpoint
+    :param scaler_type: the scaler type for the endpoint
+    :param scaler_value: the scaler value for the endpoint
+    :param workers_min: the minimum number of workers for the endpoint
+    :param workers_max: the maximum number of workers for the endpoint
+
+    :example:
+
+    >>> endpoint_id = runpod.create_endpoint("test", "template_id")
+    '''
+    raw_response = run_graphql_query(
+        endpoint_mutations.generate_endpoint_mutation(
+            name, template_id, gpu_ids,
+            network_volume_id, locations,
+            idle_timeout, scaler_type, scaler_value,
+            workers_min, workers_max
+        )
+    )
+
+    return raw_response["data"]["saveEndpoint"]

examples/api/create_template.py

@@ -27,6 +27,9 @@ def run_graphql_query(query: str) -> Dict[str, Any]:
         raise error.AuthenticationError("Unauthorized request, please check your API key.")
 
     if "errors" in response.json():
-        raise error.QueryError(response.json()["errors"][0]["message"])
+        raise error.QueryError(
+            response.json()["errors"][0]["message"],
+            query
+        )
 
     return response.json()

runpod/__init__.py

@@ -0,0 +1,59 @@
+""" RunPod | API Wrapper | Mutations | Endpoints """
+
+# pylint: disable=too-many-arguments
+
+def generate_endpoint_mutation(
+    name:str, template_id:str, gpu_ids:str="AMPERE_16",
+    network_volume_id:str=None, locations:str=None,
+    idle_timeout:int=5, scaler_type:str="QUEUE_DELAY", scaler_value:int=4,
+    workers_min:int=0, workers_max:int=3
+):
+    """ Generate a string for a GraphQL mutation to create a new endpoint. """
+    input_fields = []
+
+    # ------------------------------ Required Fields ----------------------------- #
+    input_fields.append(f'name: "{name}"')
+    input_fields.append(f'templateId: "{template_id}"')
+    input_fields.append(f'gpuIds: "{gpu_ids}"')
+
+    # ------------------------------ Optional Fields ----------------------------- #
+    if network_volume_id is not None:
+        input_fields.append(f'networkVolumeId: "{network_volume_id}"')
+    else:
+        input_fields.append('networkVolumeId: ""')
+
+    if locations is not None:
+        input_fields.append(f'locations: "{locations}"')
+    else:
+        input_fields.append('locations: ""')
+
+    input_fields.append(f'idleTimeout: {idle_timeout}')
+    input_fields.append(f'scalerType: "{scaler_type}"')
+    input_fields.append(f'scalerValue: {scaler_value}')
+    input_fields.append(f'workersMin: {workers_min}')
+    input_fields.append(f'workersMax: {workers_max}')
+
+    # Format the input fields into a string
+    input_fields_string = ", ".join(input_fields)
+
+    return f"""
+    mutation {{
+        saveEndpoint(
+            input: {{
+                {input_fields_string}
+            }}
+        ) {{
+            id
+            name
+            templateId
+            gpuIds
+            networkVolumeId
+            locations
+            idleTimeout
+            scalerType
+            scalerValue
+            workersMin
+            workersMax
+        }}
+    }}
+    """