Adds Python SDK

Author: rachfop

docs/sdks/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "SDKs",
+  "position": 6,
+  "link": {
+    "type": "generated-index",
+    "description": "Work and manage your Pods, templates, Serverless, and more with the help of our SDKs."
+  }
+}

docs/sdks/hello/__init__.py

@@ -0,0 +1 @@
+api_key = "5YLEDXAQKUKF86DX487GVYNGX3GDVW81Q881N5A4"

docs/sdks/hello/test.py

@@ -0,0 +1,22 @@
+import runpod
+
+try:
+    new_template = runpod.create_template(
+        name="testing-02", image_name="runpod/base:0.4.4", 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/sdks/overview.md

@@ -0,0 +1,9 @@
+---
+title: Overview
+description: Overview of the SDKs
+sidebar_position: 1
+---
+
+RunPod provides mutliple SDKs to interact with the RunPod API.
+
+The SDKs are available in multiple languages and are open source.

docs/sdks/python/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "Python",
+  "position": 6,
+  "link": {
+    "type": "generated-index",
+    "description": "Use the RunPod Python SDK."
+  }
+}

docs/sdks/python/api.md

@@ -0,0 +1,78 @@
+---
+title: API
+---
+
+## Get Endpoints
+
+To fetch all available endpoints from the API, use the get_endpoints function.
+This function returns a list of endpoint configurations available for use.
+
+```python
+import runpod
+
+endpoints = runpod.get_endpoints()
+
+print(endpoints)
+```
+
+## Create Template
+
+You can create a new template in RunPod by specifying the name and the Docker image to use.
+This is useful for setting up environments with pre-defined configurations.
+
+```python
+import runpod
+
+
+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)
+```
+
+## Create Endpoint
+
+Creating an endpoint involves first creating a template and then setting up the endpoint with the template ID.
+You can specify GPU requirements, the number of workers, and other configurations.
+Your Template name must be unique.
+
+```python
+import runpod
+
+try:
+
+    new_template = runpod.create_template(
+        name="test",
+        image_name="runpod/base:0.4.4",
+        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)
+```
+
+```json
+{'id': 'cx829zvv9e', 'name': 'testing-01', 'imageName': 'runpod/base:0.4.4', 'dockerArgs': '', 'containerDiskInGb': 10, 'volumeInGb': 0, 'volumeMountPath': '/workspace', 'ports': None, 'env': [], 'isServerless': True}
+{'id': '838j9id2xmmwew', 'name': 'test', 'templateId': 'cx829zvv9e', 'gpuIds': 'AMPERE_16', 'networkVolumeId': None, 'locations': None, 'idleTimeout': 5, 'scalerType': 'QUEUE_DELAY', 'scalerValue': 4, 'workersMin': 0, 'workersMax': 1}
+```

docs/sdks/python/endpoints.md

@@ -0,0 +1,45 @@
+---
+title: Endpoints
+---
+
+## Run Sync
+
+## Run
+
+### Async Job requests
+
+Example of calling an endpoint using asyncio.
+
+## Health
+
+Example of calling a Health Endpoint.
+
+```python
+import runpod
+
+endpoint = runpod.Endpoint("gwp4kx5yd3nur1")
+
+endpoint_health = endpoint.health()
+
+print(endpoint_health)
+```
+
+## Streaming
+
+Example of Streaming your Endpoint.
+
+```python
+import runpod
+
+endpoint = runpod.Endpoint("gwp4kx5yd3nur1")
+
+run_request = endpoint.run({
+    "input": {
+        "mock_return": ["a", "b", "c", "d", "e", "f", "g"],
+        "mock_delay": 1,
+    }
+})
+
+for output in run_request.stream():
+    print(output)
+```

docs/sdks/python/installation.md

@@ -0,0 +1,13 @@
+---
+title: Installation
+sidebar_position: 2
+---
+
+The RunPod Python SDK supports Python 3.8 or greater.
+Using virtual environments are recommended.
+
+## Install
+
+```bash
+pip install runpod
+```

docs/sdks/python/overview.md

@@ -0,0 +1,41 @@
+---
+title: Overview
+sidebar_position: 1
+---
+
+## Project structure
+
+RunPod Serverless is a monorepo that contains multiple services.
+
+```text
+.
+├── Dockerfile               # Docker configuration
+├── LICENSE                  # License information
+├── README.md                # Project documentation
+├── builder
+│   ├── requirements.txt     # Dependencies
+│   └── setup.sh             # Setup script
+└── src
+    └── __init__.py          # API key reference
+    └── handler.py           # Main handler code
+```
+
+## Add your API key
+
+In most cases, you'll add your `api_key` variable to the `__init__.py` file.
+
+```python
+api_key = "YOUR_API_KEY"
+```
+
+This file will be read upon every execution of your code.
+
+Alternatively, you can set your API key in your environment variables.
+Use an environment variable and load it into your code.
+
+```python
+import runpod
+import os
+
+runpod.api_key = os.getenv("RUNPOD_API_KEY")
+```

docs/sdks/python/serverless.md

@@ -0,0 +1,63 @@
+---
+title: Serverless
+---
+
+The Python SDK allows you to create Serverless Workers that are deployed to RunPod as custom Endpoints.
+
+## Set your Endpoint Id
+
+Pass your Endpoint Id on the `Endpoint` class.
+
+```python
+import runpod
+
+endpoint = runpod.Endpoint("YOUR_ENDPOINT_ID")
+```
+
+This allows all calls to pass through your Endpoint Id with a valid API key.
+
+## Run the Endpoint
+
+Run the Endpoint with the either the asynchronous `run` or synchronous `run_sync` method.
+
+Set your method call on the instances of the endpoint.
+`run` returns a Job Id.
+
+```python
+import runpod
+
+endpoint = runpod.Endpoint("YOUR_ENDPOINT_ID")
+
+endpoint.run(
+    {"input": "your custom prompt"}
+)
+```
+
+---
+
+Alternatively, use can set `run_sync` for synchronously requests.
+`run_sync` returns a dictionary of strings or any.
+
+```python
+import runpod
+
+endpoint = runpod.Endpoint("YOUR_ENDPOINT_ID")
+
+endpoint.run_sync(
+    {"input": "your custom prompt"}
+)
+```
+
+You can also set a timeout on the `run_sync` request.
+The timeout is set in seconds.
+
+```python
+import runpod
+
+endpoint = runpod.Endpoint("YOUR_ENDPOINT_ID")
+
+endpoint.run_sync(
+    {"input": "your custom prompt"},
+    timeout=60
+)
+```