+ -
+
+
runpod
+ index.html
+ Package
+ Package
+ PUBLIC
+ Allows runpod to be imported as a module.
+ -
+
+
runpod.api
+ runpod.api.html
+ Package
+ Package
+ PUBLIC
+ Allows api_wrapper to be imported as a module.
+ -
+
+
runpod.api.ctl_commands
+ runpod.api.ctl_commands.html
+ Module
+ Module
+ PUBLIC
+ RunPod | API Wrapper | CTL Commands
+ -
+
+
runpod.api.graphql
+ runpod.api.graphql.html
+ Module
+ Module
+ PUBLIC
+ RunPod | API Wrapper | GraphQL
+ -
+
+
runpod.api.mutations
+ runpod.api.mutations.html
+ Package
+ Package
+ PUBLIC
+ Allows for the creation of mutations in the GraphQL API.
+ -
+
+
runpod.api.mutations.container_register_auth
+ runpod.api.mutations.container_register_auth.html
+ Module
+ Module
+ PUBLIC
+ RunPod | API Wrapper | Mutations | Container Registry Auth
+ -
+
+
runpod.api.mutations.endpoints
+ runpod.api.mutations.endpoints.html
+ Module
+ Module
+ PUBLIC
+ RunPod | API Wrapper | Mutations | Endpoints
+ -
+
+
runpod.api.mutations.pods
+ runpod.api.mutations.pods.html
+ Module
+ Module
+ PUBLIC
+ RunPod | API Wrapper | Mutations | Pods
+ -
+
+
runpod.api.mutations.templates
+ runpod.api.mutations.templates.html
+ Module
+ Module
+ PUBLIC
+ RunPod | API Wrapper | Mutations | Templates
+ -
+
+
runpod.api.mutations.user
+ runpod.api.mutations.user.html
+ Module
+ Module
+ PUBLIC
+ RunPod | API | Mutations | User
+ -
+
+
runpod.api.queries
+ runpod.api.queries.html
+ Package
+ Package
+ PUBLIC
+ Allows queries to be imported as a module.
+ -
+
+
runpod.api.queries.endpoints
+ runpod.api.queries.endpoints.html
+ Module
+ Module
+ PUBLIC
+ GraphQL queries for endpoints.
+ -
+
+
runpod.api.queries.gpus
+ runpod.api.queries.gpus.html
+ Module
+ Module
+ PUBLIC
+ RunPod | API | Queries | GPUs
+ -
+
+
runpod.api.queries.pods
+ runpod.api.queries.pods.html
+ Module
+ Module
+ PUBLIC
+ RunPod | API Wrapper | Queries | GPUs
+ -
+
+
runpod.api.queries.user
+ runpod.api.queries.user.html
+ Module
+ Module
+ PUBLIC
+ RunPod | API | Queries | User
+ -
+
+
runpod.cli
+ runpod.cli.html
+ Package
+ Package
+ PUBLIC
+ Allows the CLI to be imported as a module.
+ -
+
+
runpod.cli.entry
+ runpod.cli.entry.html
+ Module
+ Module
+ PUBLIC
+ RunPod | CLI | Entry
+ -
+
+
runpod.cli.groups
+ runpod.cli.groups.html
+ Package
+ Package
+ PUBLIC
+ Allow CLI groups to be imported from the runpod.cli module.
+ -
+
+
runpod.cli.groups.config
+ runpod.cli.groups.config.html
+ Package
+ Package
+ PUBLIC
+ Config related CLI functions.
+ -
+
+
runpod.cli.groups.config.commands
+ runpod.cli.groups.config.commands.html
+ Module
+ Module
+ PUBLIC
+ Commands for the config command group
+ -
+
+
runpod.cli.groups.config.functions
+ runpod.cli.groups.config.functions.html
+ Module
+ Module
+ PUBLIC
+ runpod | cli | config.py
+ -
+
+
runpod.cli.groups.exec
+ runpod.cli.groups.exec.html
+ Package
+ Package
+ PUBLIC
+ A collection of CLI execution tools
+ -
+
+
runpod.cli.groups.exec.commands
+ runpod.cli.groups.exec.commands.html
+ Module
+ Module
+ PUBLIC
+ RunPod | CLI | Exec | Commands
+ -
+
+
runpod.cli.groups.exec.functions
+ runpod.cli.groups.exec.functions.html
+ Module
+ Module
+ PUBLIC
+ RunPod | CLI | Exec | Functions
+ -
+
+
runpod.cli.groups.exec.helpers
+ runpod.cli.groups.exec.helpers.html
+ Module
+ Module
+ PUBLIC
+ Helper functions for the runpod cli group exec command
+ -
+
+
runpod.cli.groups.pod
+ runpod.cli.groups.pod.html
+ Package
+ Package
+ PUBLIC
+ A collection of commands for managing pods.
+ -
+
+
runpod.cli.groups.pod.commands
+ runpod.cli.groups.pod.commands.html
+ Module
+ Module
+ PUBLIC
+ RunPod | CLI | Pod | Commands
+ -
+
+
runpod.cli.groups.project
+ runpod.cli.groups.project.html
+ Package
+ Package
+ PUBLIC
+ Allows project import
+ -
+
+
runpod.cli.groups.project.commands
+ runpod.cli.groups.project.commands.html
+ Module
+ Module
+ PUBLIC
+ RunPod | CLI | Project | Commands
+ -
+
+
runpod.cli.groups.project.functions
+ runpod.cli.groups.project.functions.html
+ Module
+ Module
+ PUBLIC
+ RunPod | CLI | Project | Functions
+ -
+
+
runpod.cli.groups.project.helpers
+ runpod.cli.groups.project.helpers.html
+ Module
+ Module
+ PUBLIC
+ Helper functions for project group commands.
+ -
+
+
runpod.cli.groups.ssh
+ runpod.cli.groups.ssh.html
+ Package
+ Package
+ PUBLIC
+ CLI functions for SSH.
+ -
+
+
runpod.cli.groups.ssh.commands
+ runpod.cli.groups.ssh.commands.html
+ Module
+ Module
+ PUBLIC
+ RunPod | CLI | SSH | Commands
+ -
+
+
runpod.cli.groups.ssh.functions
+ runpod.cli.groups.ssh.functions.html
+ Module
+ Module
+ PUBLIC
+ RunPod | CLI | SSH | Functions
+ -
+
+
runpod.cli.utils
+ runpod.cli.utils.html
+ Package
+ Package
+ PUBLIC
+ Collection of utility functions for the CLI
+ -
+
+
runpod.cli.utils.rp_info
+ runpod.cli.utils.rp_info.html
+ Module
+ Module
+ PUBLIC
+ RunPod | CLI | Utils | rp_info
+ -
+
+
runpod.cli.utils.rp_runpodignore
+ runpod.cli.utils.rp_runpodignore.html
+ Module
+ Module
+ PUBLIC
+ Reads the .runpodignore file and returns a list of files to ignore.
+ -
+
+
runpod.cli.utils.rp_sync
+ runpod.cli.utils.rp_sync.html
+ Module
+ Module
+ PUBLIC
+ Watches a directory for changes and syncs them to a remote directory.
+ -
+
+
runpod.cli.utils.rp_userspace
+ runpod.cli.utils.rp_userspace.html
+ Module
+ Module
+ PUBLIC
+ RunPod | CLI | Utils | Userspace
+ -
+
+
runpod.cli.utils.ssh_cmd
+ runpod.cli.utils.ssh_cmd.html
+ Module
+ Module
+ PUBLIC
+ RunPod | CLI | Utils | SSH Command
+ -
+
+
runpod.endpoint
+ runpod.endpoint.html
+ Package
+ Package
+ PUBLIC
+ Allows endpoints to be imported as a module.
+ -
+
+
runpod.endpoint.asyncio
+ runpod.endpoint.asyncio.html
+ Package
+ Package
+ PUBLIC
+ Asyncio endpoint for runpod.
+ -
+
+
runpod.endpoint.asyncio.asyncio_runner
+ runpod.endpoint.asyncio.asyncio_runner.html
+ Module
+ Module
+ PUBLIC
+ Module for running endpoints asynchronously.
+ -
+
+
runpod.endpoint.helpers
+ runpod.endpoint.helpers.html
+ Module
+ Module
+ PUBLIC
+ Helper functions for the RunPod Endpoint API.
+ -
+
+
runpod.endpoint.runner
+ runpod.endpoint.runner.html
+ Module
+ Module
+ PUBLIC
+ RunPod | Python | Endpoint Runner
+ -
+
+
runpod.error
+ runpod.error.html
+ Module
+ Module
+ PUBLIC
+ runpd | error.py
+ -
+
+
runpod.serverless
+ runpod.serverless.html
+ Package
+ Package
+ PUBLIC
+ Contains the main entrypoint for the RunPod Serverless Worker.
+ -
+
+
runpod.serverless.core
+ runpod.serverless.core.html
+ Module
+ Module
+ PUBLIC
+ Core functionality for the runpod serverless worker.
+ -
+
+
runpod.serverless.modules
+ runpod.serverless.modules.html
+ Package
+ Package
+ PUBLIC
+ Allows modules to be imported from the modules directory.
+ -
+
+
runpod.serverless.modules.rp_fastapi
+ runpod.serverless.modules.rp_fastapi.html
+ Module
+ Module
+ PUBLIC
+ Used to launch the FastAPI web server when worker is running in API mode.
+ -
+
+
runpod.serverless.modules.rp_handler
+ runpod.serverless.modules.rp_handler.html
+ Module
+ Module
+ PUBLIC
+ Retrieve handler info.
+ -
+
+
runpod.serverless.modules.rp_http
+ runpod.serverless.modules.rp_http.html
+ Module
+ Module
+ PUBLIC
+ This module is used to handle HTTP requests.
+ -
+
+
runpod.serverless.modules.rp_job
+ runpod.serverless.modules.rp_job.html
+ Module
+ Module
+ PUBLIC
+ Job related helpers.
+ -
+
+
runpod.serverless.modules.rp_local
+ runpod.serverless.modules.rp_local.html
+ Module
+ Module
+ PUBLIC
+ runpod | serverless | rp_local.py Provides the local testing functionality for runpod serverless worker.
+ -
+
+
runpod.serverless.modules.rp_logger
+ runpod.serverless.modules.rp_logger.html
+ Module
+ Module
+ PUBLIC
+ PodWorker | modules | logging.py
+ -
+
+
runpod.serverless.modules.rp_ping
+ runpod.serverless.modules.rp_ping.html
+ Module
+ Module
+ PUBLIC
+ This module defines the Heartbeat class. The heartbeat is responsible for sending periodic pings to the Runpod server.
+ -
+
+
runpod.serverless.modules.rp_progress
+ runpod.serverless.modules.rp_progress.html
+ Module
+ Module
+ PUBLIC
+ RunPod Progress Module
+ -
+
+
runpod.serverless.modules.rp_scale
+ runpod.serverless.modules.rp_scale.html
+ Module
+ Module
+ PUBLIC
+ runpod | serverless | rp_scale.py Provides the functionality for scaling the runpod serverless worker.
+ -
+
+
runpod.serverless.modules.rp_tips
+ runpod.serverless.modules.rp_tips.html
+ Module
+ Module
+ PUBLIC
+ RunPod Tips
+ -
+
+
runpod.serverless.modules.worker_state
+ runpod.serverless.modules.worker_state.html
+ Module
+ Module
+ PUBLIC
+ Handles getting stuff from environment variables and updating the global state like job id.
+ -
+
+
runpod.serverless.utils
+ runpod.serverless.utils.html
+ Package
+ Package
+ PUBLIC
+ Allows for the import of all modules in the utils directory.
+ -
+
+
runpod.serverless.utils.rp_cleanup
+ runpod.serverless.utils.rp_cleanup.html
+ Module
+ Module
+ PUBLIC
+ runpod | serverless | cleanup.py
+ -
+
+
runpod.serverless.utils.rp_cuda
+ runpod.serverless.utils.rp_cuda.html
+ Module
+ Module
+ PUBLIC
+ Provides some of the torch.cuda functionality without requiring torch.
+ -
+
+
runpod.serverless.utils.rp_debugger
+ runpod.serverless.utils.rp_debugger.html
+ Module
+ Module
+ PUBLIC
+ runpod | serverless | rp_debugger.py
+ -
+
+
runpod.serverless.utils.rp_download
+ runpod.serverless.utils.rp_download.html
+ Module
+ Module
+ PUBLIC
+ PodWorker | modules | download.py
+ -
+
+
runpod.serverless.utils.rp_upload
+ runpod.serverless.utils.rp_upload.html
+ Module
+ Module
+ PUBLIC
+ PodWorker | modules | upload.py
+ -
+
+
runpod.serverless.utils.rp_validator
+ runpod.serverless.utils.rp_validator.html
+ Module
+ Module
+ PUBLIC
+ runpod | serverless | utils | validator.py Provides a function to validate the input to the model.
+ -
+
+
runpod.serverless.worker
+ runpod.serverless.worker.html
+ Module
+ Module
+ PUBLIC
+ runpod | serverless | worker_loop.py Called to convert a container into a worker pod for the runpod serverless platform.
+ -
+
+
runpod.user_agent
+ runpod.user_agent.html
+ Module
+ Module
+ PUBLIC
+ User-Agent for RunPod-Python-SDK
+ -
+
+
runpod.version
+ runpod.version.html
+ Module
+ Module
+ PUBLIC
+ runpod-python version
+ -
+
+
runpod.version.get_version
+ runpod.version.html#get_version
+ Function
+ Function
+ PUBLIC
+ Get the version of runpod-python
+ -
+
+
runpod.version.__version__
+ runpod.version.html#__version__
+ Attribute
+ Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_logger.MAX_MESSAGE_LENGTH
+ runpod.serverless.modules.rp_logger.html#MAX_MESSAGE_LENGTH
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_logger.LOG_LEVELS
+ runpod.serverless.modules.rp_logger.html#LOG_LEVELS
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_logger._validate_log_level
+ runpod.serverless.modules.rp_logger.html#_validate_log_level
+ Function
+ Function
+ PRIVATE
+ Checks the debug level and returns the debug level name.
+ -
+
+
runpod.serverless.modules.rp_logger.RunPodLogger
+ runpod.serverless.modules.rp_logger.RunPodLogger.html
+ Class
+ Class
+ PUBLIC
+ Singleton class for logging.
+ -
+
+
runpod.serverless.modules.rp_logger.RunPodLogger.__instance
+ runpod.serverless.modules.rp_logger.RunPodLogger.html#__instance
+ Attribute
+ Class Variable
+ PRIVATE
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_logger.RunPodLogger.level
+ runpod.serverless.modules.rp_logger.RunPodLogger.html#level
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_logger.RunPodLogger.__new__
+ runpod.serverless.modules.rp_logger.RunPodLogger.html#__new__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_logger.RunPodLogger.set_level
+ runpod.serverless.modules.rp_logger.RunPodLogger.html#set_level
+ Function
+ Method
+ PUBLIC
+ Set the debug level for logging. Can be set to the name or value of the debug level.
+ -
+
+
runpod.serverless.modules.rp_logger.RunPodLogger.log
+ runpod.serverless.modules.rp_logger.RunPodLogger.html#log
+ Function
+ Method
+ PUBLIC
+ Log message to stdout if RUNPOD_DEBUG is true.
+ -
+
+
runpod.serverless.modules.rp_logger.RunPodLogger.secret
+ runpod.serverless.modules.rp_logger.RunPodLogger.html#secret
+ Function
+ Method
+ PUBLIC
+ Censors secrets for logging. Replaces everything except the first and last characters with *
+ -
+
+
runpod.serverless.modules.rp_logger.RunPodLogger.debug
+ runpod.serverless.modules.rp_logger.RunPodLogger.html#debug
+ Function
+ Method
+ PUBLIC
+ debug log
+ -
+
+
runpod.serverless.modules.rp_logger.RunPodLogger.info
+ runpod.serverless.modules.rp_logger.RunPodLogger.html#info
+ Function
+ Method
+ PUBLIC
+ info log
+ -
+
+
runpod.serverless.modules.rp_logger.RunPodLogger.warn
+ runpod.serverless.modules.rp_logger.RunPodLogger.html#warn
+ Function
+ Method
+ PUBLIC
+ warn log
+ -
+
+
runpod.serverless.modules.rp_logger.RunPodLogger.error
+ runpod.serverless.modules.rp_logger.RunPodLogger.html#error
+ Function
+ Method
+ PUBLIC
+ error log
+ -
+
+
runpod.serverless.modules.rp_logger.RunPodLogger.tip
+ runpod.serverless.modules.rp_logger.RunPodLogger.html#tip
+ Function
+ Method
+ PUBLIC
+ tip log
+ -
+
+
runpod.serverless.modules.worker_state.REF_COUNT_ZERO
+ runpod.serverless.modules.worker_state.html#REF_COUNT_ZERO
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.worker_state.WORKER_ID
+ runpod.serverless.modules.worker_state.html#WORKER_ID
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.worker_state.IS_LOCAL_TEST
+ runpod.serverless.modules.worker_state.html#IS_LOCAL_TEST
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.worker_state.Job
+ runpod.serverless.modules.worker_state.Job.html
+ Class
+ Class
+ PUBLIC
+ Represents a job object.
+ -
+
+
runpod.serverless.modules.worker_state.Job.__init__
+ runpod.serverless.modules.worker_state.Job.html#__init__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.worker_state.Job.id
+ runpod.serverless.modules.worker_state.Job.html#id
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.worker_state.Job.input
+ runpod.serverless.modules.worker_state.Job.html#input
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.worker_state.Job.webhook
+ runpod.serverless.modules.worker_state.Job.html#webhook
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.worker_state.Job.__eq__
+ runpod.serverless.modules.worker_state.Job.html#__eq__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.worker_state.Job.__hash__
+ runpod.serverless.modules.worker_state.Job.html#__hash__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.worker_state.Job.__str__
+ runpod.serverless.modules.worker_state.Job.html#__str__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.worker_state.Jobs
+ runpod.serverless.modules.worker_state.Jobs.html
+ Class
+ Class
+ PUBLIC
+ Track the state of current jobs.
+ -
+
+
runpod.serverless.modules.worker_state.Jobs._instance
+ runpod.serverless.modules.worker_state.Jobs.html#_instance
+ Attribute
+ Class Variable
+ PRIVATE
+ Undocumented
+ -
+
+
runpod.serverless.modules.worker_state.Jobs.jobs
+ runpod.serverless.modules.worker_state.Jobs.html#jobs
+ Attribute
+ Class Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.worker_state.Jobs.__new__
+ runpod.serverless.modules.worker_state.Jobs.html#__new__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.worker_state.Jobs.add_job
+ runpod.serverless.modules.worker_state.Jobs.html#add_job
+ Function
+ Method
+ PUBLIC
+ Adds a job to the list of jobs.
+ -
+
+
runpod.serverless.modules.worker_state.Jobs.remove_job
+ runpod.serverless.modules.worker_state.Jobs.html#remove_job
+ Function
+ Method
+ PUBLIC
+ Removes a job from the list of jobs.
+ -
+
+
runpod.serverless.modules.worker_state.Jobs.get_job
+ runpod.serverless.modules.worker_state.Jobs.html#get_job
+ Function
+ Method
+ PUBLIC
+ Returns the job with the given id. Used within rp_fastapi.py for local testing.
+ -
+
+
runpod.serverless.modules.worker_state.Jobs.get_job_list
+ runpod.serverless.modules.worker_state.Jobs.html#get_job_list
+ Function
+ Method
+ PUBLIC
+ Returns the list of jobs as a string.
+ -
+
+
runpod.serverless.modules.worker_state.Jobs.get_job_count
+ runpod.serverless.modules.worker_state.Jobs.html#get_job_count
+ Function
+ Method
+ PUBLIC
+ Returns the number of jobs.
+ -
+
+
runpod.serverless.modules.rp_tips.log
+ runpod.serverless.modules.rp_tips.html#log
+ Attribute
+ Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_tips.check_return_size
+ runpod.serverless.modules.rp_tips.html#check_return_size
+ Function
+ Function
+ PUBLIC
+ Checks the size of the return body. If the size is above 20MB, it will recommend using storage upload.
+ -
+
+
runpod.serverless.modules.rp_job.JOB_GET_URL
+ runpod.serverless.modules.rp_job.html#JOB_GET_URL
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_job.log
+ runpod.serverless.modules.rp_job.html#log
+ Attribute
+ Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_job.job_list
+ runpod.serverless.modules.rp_job.html#job_list
+ Attribute
+ Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_job._job_get_url
+ runpod.serverless.modules.rp_job.html#_job_get_url
+ Function
+ Function
+ PRIVATE
+ Prepare the URL for making a 'get' request to the serverless API (sls).
+ -
+
+
runpod.serverless.modules.rp_job.get_job
+ runpod.serverless.modules.rp_job.html#get_job
+ Function
+ Function
+ PUBLIC
+ Get the job from the queue. Will continue trying to get a job until one is available.
+ -
+
+
runpod.serverless.modules.rp_job.run_job
+ runpod.serverless.modules.rp_job.html#run_job
+ Function
+ Function
+ PUBLIC
+ Run the job using the handler.
+ -
+
+
runpod.serverless.modules.rp_job.run_job_generator
+ runpod.serverless.modules.rp_job.html#run_job_generator
+ Function
+ Function
+ PUBLIC
+ Run generator job used to stream output. Yields output partials from the generator.
+ -
+
+
runpod.serverless.core.log
+ runpod.serverless.core.html#log
+ Attribute
+ Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.core.CGetJobResult
+ runpod.serverless.core.CGetJobResult.html
+ Class
+ Class
+ PUBLIC
+ result of _runpod_sls_get_jobs. ## fields - `res_len` the number bytes were written to the `dst_buf` passed to _runpod_sls_get_jobs. - `status_code` tells you what happened. see CGetJobResult.status_code for more information.
+ -
+
+
runpod.serverless.core.CGetJobResult._fields_
+ runpod.serverless.core.CGetJobResult.html#_fields_
+ Attribute
+ Class Variable
+ PRIVATE
+ Undocumented
+ -
+
+
runpod.serverless.core.CGetJobResult.__str__
+ runpod.serverless.core.CGetJobResult.html#__str__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.core.Hook
+ runpod.serverless.core.Hook.html
+ Class
+ Class
+ PUBLIC
+ Singleton class for interacting with sls_core.so
+ -
+
+
runpod.serverless.core.Hook._instance
+ runpod.serverless.core.Hook.html#_instance
+ Attribute
+ Class Variable
+ PRIVATE
+ Undocumented
+ -
+
+
runpod.serverless.core.Hook._get_jobs
+ runpod.serverless.core.Hook.html#_get_jobs
+ Attribute
+ Instance Variable
+ PRIVATE
+ Undocumented
+ -
+
+
runpod.serverless.core.Hook._progress_update
+ runpod.serverless.core.Hook.html#_progress_update
+ Attribute
+ Instance Variable
+ PRIVATE
+ Undocumented
+ -
+
+
runpod.serverless.core.Hook._stream_output
+ runpod.serverless.core.Hook.html#_stream_output
+ Attribute
+ Instance Variable
+ PRIVATE
+ Undocumented
+ -
+
+
runpod.serverless.core.Hook._post_output
+ runpod.serverless.core.Hook.html#_post_output
+ Attribute
+ Instance Variable
+ PRIVATE
+ Undocumented
+ -
+
+
runpod.serverless.core.Hook._finish_stream
+ runpod.serverless.core.Hook.html#_finish_stream
+ Attribute
+ Instance Variable
+ PRIVATE
+ Undocumented
+ -
+
+
runpod.serverless.core.Hook.__new__
+ runpod.serverless.core.Hook.html#__new__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.core.Hook.__init__
+ runpod.serverless.core.Hook.html#__init__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.core.Hook.rust_so_path
+ runpod.serverless.core.Hook.html#rust_so_path
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.core.Hook.rust_crate_version
+ runpod.serverless.core.Hook.html#rust_crate_version
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.core.Hook._initialized
+ runpod.serverless.core.Hook.html#_initialized
+ Attribute
+ Instance Variable
+ PRIVATE
+ Undocumented
+ -
+
+
runpod.serverless.core.Hook._json_serialize_job_data
+ runpod.serverless.core.Hook.html#_json_serialize_job_data
+ Function
+ Method
+ PRIVATE
+ Undocumented
+ -
+
+
runpod.serverless.core.Hook.get_jobs
+ runpod.serverless.core.Hook.html#get_jobs
+ Function
+ Method
+ PUBLIC
+ Get a job or jobs from the queue. The jobs are returned as a list of Job objects.
+ -
+
+
runpod.serverless.core.Hook.progress_update
+ runpod.serverless.core.Hook.html#progress_update
+ Function
+ Method
+ PUBLIC
+ send a progress update to AI-API.
+ -
+
+
runpod.serverless.core.Hook.stream_output
+ runpod.serverless.core.Hook.html#stream_output
+ Function
+ Method
+ PUBLIC
+ send part of a streaming result to AI-API.
+ -
+
+
runpod.serverless.core.Hook.post_output
+ runpod.serverless.core.Hook.html#post_output
+ Function
+ Method
+ PUBLIC
+ send the result of a job to AI-API. Returns True if the task was successfully stored, False otherwise.
+ -
+
+
runpod.serverless.core.Hook.finish_stream
+ runpod.serverless.core.Hook.html#finish_stream
+ Function
+ Method
+ PUBLIC
+ tell the SLS queue that the result of a streaming job is complete.
+ -
+
+
runpod.serverless.core._process_job
+ runpod.serverless.core.html#_process_job
+ Function
+ Function
+ PRIVATE
+ Process a single job.
+ -
+
+
runpod.serverless.core.run
+ runpod.serverless.core.html#run
+ Function
+ Function
+ PUBLIC
+ Run the worker.
+ -
+
+
runpod.serverless.core.main
+ runpod.serverless.core.html#main
+ Function
+ Function
+ PUBLIC
+ Run the worker in an asyncio event loop.
+ -
+
+
runpod.user_agent.construct_user_agent
+ runpod.user_agent.html#construct_user_agent
+ Function
+ Function
+ PUBLIC
+ Constructs the User-Agent string for the RunPod-Python-SDK
+ -
+
+
runpod.user_agent.USER_AGENT
+ runpod.user_agent.html#USER_AGENT
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_local.log
+ runpod.serverless.modules.rp_local.html#log
+ Attribute
+ Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_local.run_local
+ runpod.serverless.modules.rp_local.html#run_local
+ Function
+ Function
+ PUBLIC
+ Runs the worker locally.
+ -
+
+
runpod.serverless.modules.rp_handler.is_generator
+ runpod.serverless.modules.rp_handler.html#is_generator
+ Function
+ Function
+ PUBLIC
+ Check if handler is a generator function.
+ -
+
+
runpod.serverless.modules.rp_ping.log
+ runpod.serverless.modules.rp_ping.html#log
+ Attribute
+ Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_ping.jobs
+ runpod.serverless.modules.rp_ping.html#jobs
+ Attribute
+ Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_ping.Heartbeat
+ runpod.serverless.modules.rp_ping.Heartbeat.html
+ Class
+ Class
+ PUBLIC
+ Sends heartbeats to the Runpod server.
+ -
+
+
runpod.serverless.modules.rp_ping.Heartbeat.PING_URL
+ runpod.serverless.modules.rp_ping.Heartbeat.html#PING_URL
+ Attribute
+ Class Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_ping.Heartbeat.PING_INTERVAL
+ runpod.serverless.modules.rp_ping.Heartbeat.html#PING_INTERVAL
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_ping.Heartbeat._thread_started
+ runpod.serverless.modules.rp_ping.Heartbeat.html#_thread_started
+ Attribute
+ Class Variable
+ PRIVATE
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_ping.Heartbeat.__init__
+ runpod.serverless.modules.rp_ping.Heartbeat.html#__init__
+ Function
+ Method
+ PUBLIC
+ Initializes the Heartbeat class.
+ -
+
+
runpod.serverless.modules.rp_ping.Heartbeat._session
+ runpod.serverless.modules.rp_ping.Heartbeat.html#_session
+ Attribute
+ Instance Variable
+ PRIVATE
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_ping.Heartbeat.start_ping
+ runpod.serverless.modules.rp_ping.Heartbeat.html#start_ping
+ Function
+ Method
+ PUBLIC
+ Sends heartbeat pings to the Runpod server.
+ -
+
+
runpod.serverless.modules.rp_ping.Heartbeat.ping_loop
+ runpod.serverless.modules.rp_ping.Heartbeat.html#ping_loop
+ Function
+ Method
+ PUBLIC
+ Sends heartbeat pings to the Runpod server.
+ -
+
+
runpod.serverless.modules.rp_ping.Heartbeat._send_ping
+ runpod.serverless.modules.rp_ping.Heartbeat.html#_send_ping
+ Function
+ Method
+ PRIVATE
+ Sends a heartbeat to the Runpod server.
+ -
+
+
runpod.serverless.modules.rp_scale.log
+ runpod.serverless.modules.rp_scale.html#log
+ Attribute
+ Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_scale.job_list
+ runpod.serverless.modules.rp_scale.html#job_list
+ Attribute
+ Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_scale._default_concurrency_modifier
+ runpod.serverless.modules.rp_scale.html#_default_concurrency_modifier
+ Function
+ Function
+ PRIVATE
+ Default concurrency modifier.
+ -
+
+
runpod.serverless.modules.rp_scale.JobScaler
+ runpod.serverless.modules.rp_scale.JobScaler.html
+ Class
+ Class
+ PUBLIC
+ Job Scaler. This class is responsible for scaling the number of concurrent requests.
+ -
+
+
runpod.serverless.modules.rp_scale.JobScaler.__init__
+ runpod.serverless.modules.rp_scale.JobScaler.html#__init__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_scale.JobScaler.concurrency_modifier
+ runpod.serverless.modules.rp_scale.JobScaler.html#concurrency_modifier
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_scale.JobScaler.background_get_job_tasks
+ runpod.serverless.modules.rp_scale.JobScaler.html#background_get_job_tasks
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_scale.JobScaler.job_history
+ runpod.serverless.modules.rp_scale.JobScaler.html#job_history
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_scale.JobScaler.current_concurrency
+ runpod.serverless.modules.rp_scale.JobScaler.html#current_concurrency
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_scale.JobScaler._is_alive
+ runpod.serverless.modules.rp_scale.JobScaler.html#_is_alive
+ Attribute
+ Instance Variable
+ PRIVATE
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_scale.JobScaler.is_alive
+ runpod.serverless.modules.rp_scale.JobScaler.html#is_alive
+ Function
+ Method
+ PUBLIC
+ Return whether the worker is alive or not.
+ -
+
+
runpod.serverless.modules.rp_scale.JobScaler.kill_worker
+ runpod.serverless.modules.rp_scale.JobScaler.html#kill_worker
+ Function
+ Method
+ PUBLIC
+ Whether to kill the worker.
+ -
+
+
runpod.serverless.modules.rp_scale.JobScaler.get_jobs
+ runpod.serverless.modules.rp_scale.JobScaler.html#get_jobs
+ Function
+ Method
+ PUBLIC
+ Retrieve multiple jobs from the server in parallel using concurrent requests.
+ -
+
+
runpod.serverless.modules.rp_http.JOB_DONE_URL_TEMPLATE
+ runpod.serverless.modules.rp_http.html#JOB_DONE_URL_TEMPLATE
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_http.JOB_DONE_URL
+ runpod.serverless.modules.rp_http.html#JOB_DONE_URL
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_http.JOB_STREAM_URL_TEMPLATE
+ runpod.serverless.modules.rp_http.html#JOB_STREAM_URL_TEMPLATE
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_http.JOB_STREAM_URL
+ runpod.serverless.modules.rp_http.html#JOB_STREAM_URL
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_http.log
+ runpod.serverless.modules.rp_http.html#log
+ Attribute
+ Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_http.job_list
+ runpod.serverless.modules.rp_http.html#job_list
+ Attribute
+ Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_http._transmit
+ runpod.serverless.modules.rp_http.html#_transmit
+ Function
+ Function
+ PRIVATE
+ Wrapper for transmitting results via POST.
+ -
+
+
runpod.serverless.modules.rp_http._handle_result
+ runpod.serverless.modules.rp_http.html#_handle_result
+ Function
+ Function
+ PRIVATE
+ A helper function to handle the result, either for sending or streaming.
+ -
+
+
runpod.serverless.modules.rp_http.send_result
+ runpod.serverless.modules.rp_http.html#send_result
+ Function
+ Function
+ PUBLIC
+ Return the job results.
+ -
+
+
runpod.serverless.modules.rp_http.stream_result
+ runpod.serverless.modules.rp_http.html#stream_result
+ Function
+ Function
+ PUBLIC
+ Return the stream job results.
+ -
+
+
runpod.serverless.utils.rp_download.calculate_chunk_size
+ runpod.serverless.utils.rp_download.html#calculate_chunk_size
+ Function
+ Function
+ PUBLIC
+ Calculates the chunk size based on the file size.
+ -
+
+
runpod.serverless.utils.rp_download.download_files_from_urls
+ runpod.serverless.utils.rp_download.html#download_files_from_urls
+ Function
+ Function
+ PUBLIC
+ Accepts a single URL or a list of URLs and downloads the files. Returns the list of downloaded file absolute paths. Saves the files in a directory called "downloaded_files" in the job directory.
+ -
+
+
runpod.serverless.utils.rp_download.file
+ runpod.serverless.utils.rp_download.html#file
+ Function
+ Function
+ PUBLIC
+ Downloads a single file from a given URL, file is given a random name. First checks if the content-disposition header is set, if so, uses the file name from there. If the file is a zip file, it is extracted into a directory with the same name.
+ -
+
+
runpod.serverless.utils.rp_upload.logger
+ runpod.serverless.utils.rp_upload.html#logger
+ Attribute
+ Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.utils.rp_upload.FMT
+ runpod.serverless.utils.rp_upload.html#FMT
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.utils.rp_upload.get_boto_client
+ runpod.serverless.utils.rp_upload.html#get_boto_client
+ Function
+ Function
+ PUBLIC
+ Returns a boto3 client and transfer config for the bucket.
+ -
+
+
runpod.serverless.utils.rp_upload.upload_image
+ runpod.serverless.utils.rp_upload.html#upload_image
+ Function
+ Function
+ PUBLIC
+ Upload a single file to bucket storage.
+ -
+
+
runpod.serverless.utils.rp_upload.files
+ runpod.serverless.utils.rp_upload.html#files
+ Function
+ Function
+ PUBLIC
+ Uploads a list of files in parallel. Once all files are uploaded, the function returns the presigned URLs list.
+ -
+
+
runpod.serverless.utils.rp_upload.bucket_upload
+ runpod.serverless.utils.rp_upload.html#bucket_upload
+ Function
+ Function
+ PUBLIC
+ Uploads files to bucket storage.
+ -
+
+
runpod.serverless.utils.rp_upload.upload_file_to_bucket
+ runpod.serverless.utils.rp_upload.html#upload_file_to_bucket
+ Function
+ Function
+ PUBLIC
+ Uploads a single file to bucket storage and returns a presigned URL.
+ -
+
+
runpod.serverless.utils.rp_upload.upload_in_memory_object
+ runpod.serverless.utils.rp_upload.html#upload_in_memory_object
+ Function
+ Function
+ PUBLIC
+ Uploads an in-memory object (bytes) to bucket storage and returns a presigned URL.
+ -
+
+
runpod.serverless.utils.rp_debugger.OS_INFO
+ runpod.serverless.utils.rp_debugger.html#OS_INFO
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.utils.rp_debugger.PROCESSOR
+ runpod.serverless.utils.rp_debugger.html#PROCESSOR
+ Attribute
+ Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.utils.rp_debugger.PYTHON_VERSION
+ runpod.serverless.utils.rp_debugger.html#PYTHON_VERSION
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.utils.rp_debugger.Checkpoints
+ runpod.serverless.utils.rp_debugger.Checkpoints.html
+ Class
+ Class
+ PUBLIC
+ A singleton class to store checkpoint times.
+ -
+
+
runpod.serverless.utils.rp_debugger.Checkpoints.__instance
+ runpod.serverless.utils.rp_debugger.Checkpoints.html#__instance
+ Attribute
+ Class Variable
+ PRIVATE
+ Undocumented
+ -
+
+
runpod.serverless.utils.rp_debugger.Checkpoints.checkpoints
+ runpod.serverless.utils.rp_debugger.Checkpoints.html#checkpoints
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.utils.rp_debugger.Checkpoints.name_lookup
+ runpod.serverless.utils.rp_debugger.Checkpoints.html#name_lookup
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.utils.rp_debugger.Checkpoints.__new__
+ runpod.serverless.utils.rp_debugger.Checkpoints.html#__new__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.utils.rp_debugger.Checkpoints.add
+ runpod.serverless.utils.rp_debugger.Checkpoints.html#add
+ Function
+ Method
+ PUBLIC
+ Add a checkpoint. Returns the index of the checkpoint.
+ -
+
+
runpod.serverless.utils.rp_debugger.Checkpoints.start
+ runpod.serverless.utils.rp_debugger.Checkpoints.html#start
+ Function
+ Method
+ PUBLIC
+ Start a checkpoint.
+ -
+
+
runpod.serverless.utils.rp_debugger.Checkpoints.stop
+ runpod.serverless.utils.rp_debugger.Checkpoints.html#stop
+ Function
+ Method
+ PUBLIC
+ Stop a checkpoint.
+ -
+
+
runpod.serverless.utils.rp_debugger.Checkpoints.get_checkpoints
+ runpod.serverless.utils.rp_debugger.Checkpoints.html#get_checkpoints
+ Function
+ Method
+ PUBLIC
+ Get the results of the checkpoints.
+ -
+
+
runpod.serverless.utils.rp_debugger.Checkpoints.clear
+ runpod.serverless.utils.rp_debugger.Checkpoints.html#clear
+ Function
+ Method
+ PUBLIC
+ Clear the checkpoints.
+ -
+
+
runpod.serverless.utils.rp_debugger.LineTimer
+ runpod.serverless.utils.rp_debugger.LineTimer.html
+ Class
+ Class
+ PUBLIC
+ A utility that can be used to time code execution using the with statement. When used the times should be added to the checkpoints object.
+ -
+
+
runpod.serverless.utils.rp_debugger.LineTimer.__init__
+ runpod.serverless.utils.rp_debugger.LineTimer.html#__init__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.utils.rp_debugger.LineTimer.checkpoints
+ runpod.serverless.utils.rp_debugger.LineTimer.html#checkpoints
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.utils.rp_debugger.LineTimer.name
+ runpod.serverless.utils.rp_debugger.LineTimer.html#name
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.utils.rp_debugger.LineTimer.__enter__
+ runpod.serverless.utils.rp_debugger.LineTimer.html#__enter__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.utils.rp_debugger.LineTimer.__exit__
+ runpod.serverless.utils.rp_debugger.LineTimer.html#__exit__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.utils.rp_debugger.FunctionTimer
+ runpod.serverless.utils.rp_debugger.FunctionTimer.html
+ Class
+ Class
+ PUBLIC
+ A class-based decorator to benchmark a function.
+ -
+
+
runpod.serverless.utils.rp_debugger.FunctionTimer.__init__
+ runpod.serverless.utils.rp_debugger.FunctionTimer.html#__init__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.utils.rp_debugger.FunctionTimer.function
+ runpod.serverless.utils.rp_debugger.FunctionTimer.html#function
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.utils.rp_debugger.FunctionTimer.checkpoints
+ runpod.serverless.utils.rp_debugger.FunctionTimer.html#checkpoints
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.utils.rp_debugger.FunctionTimer.__call__
+ runpod.serverless.utils.rp_debugger.FunctionTimer.html#__call__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.utils.rp_debugger.get_debugger_output
+ runpod.serverless.utils.rp_debugger.html#get_debugger_output
+ Function
+ Function
+ PUBLIC
+ Return the debugger output.
+ -
+
+
runpod.serverless.utils.rp_debugger.clear_debugger_output
+ runpod.serverless.utils.rp_debugger.html#clear_debugger_output
+ Function
+ Function
+ PUBLIC
+ Clear the debugger output.
+ -
+
+
runpod.serverless.worker.log
+ runpod.serverless.worker.html#log
+ Attribute
+ Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.worker.job_list
+ runpod.serverless.worker.html#job_list
+ Attribute
+ Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.worker.heartbeat
+ runpod.serverless.worker.html#heartbeat
+ Attribute
+ Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.worker._is_local
+ runpod.serverless.worker.html#_is_local
+ Function
+ Function
+ PRIVATE
+ Returns True if the worker is running locally, False otherwise.
+ -
+
+
runpod.serverless.worker._process_job
+ runpod.serverless.worker.html#_process_job
+ Function
+ Function
+ PRIVATE
+ Undocumented
+ -
+
+
runpod.serverless.worker.run_worker
+ runpod.serverless.worker.html#run_worker
+ Function
+ Function
+ PUBLIC
+ Starts the worker loop for multi-processing.
+ -
+
+
runpod.serverless.worker.main
+ runpod.serverless.worker.html#main
+ Function
+ Function
+ PUBLIC
+ Checks if the worker is running locally or on RunPod. If running locally, the test job is run and the worker exits. If running on RunPod, the worker loop is created.
+ -
+
+
runpod.serverless.modules.rp_fastapi.RUNPOD_ENDPOINT_ID
+ runpod.serverless.modules.rp_fastapi.html#RUNPOD_ENDPOINT_ID
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_fastapi.TITLE
+ runpod.serverless.modules.rp_fastapi.html#TITLE
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_fastapi.DESCRIPTION
+ runpod.serverless.modules.rp_fastapi.html#DESCRIPTION
+ Attribute
+ Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_fastapi.RUN_DESCRIPTION
+ runpod.serverless.modules.rp_fastapi.html#RUN_DESCRIPTION
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_fastapi.RUNSYNC_DESCRIPTION
+ runpod.serverless.modules.rp_fastapi.html#RUNSYNC_DESCRIPTION
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_fastapi.STREAM_DESCRIPTION
+ runpod.serverless.modules.rp_fastapi.html#STREAM_DESCRIPTION
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_fastapi.STATUS_DESCRIPTION
+ runpod.serverless.modules.rp_fastapi.html#STATUS_DESCRIPTION
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_fastapi.job_list
+ runpod.serverless.modules.rp_fastapi.html#job_list
+ Attribute
+ Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_fastapi.heartbeat
+ runpod.serverless.modules.rp_fastapi.html#heartbeat
+ Attribute
+ Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_fastapi.Job
+ runpod.serverless.modules.rp_fastapi.Job.html
+ Class
+ Class
+ PUBLIC
+ Represents a job.
+ -
+
+
runpod.serverless.modules.rp_fastapi.Job.id
+ runpod.serverless.modules.rp_fastapi.Job.html#id
+ Attribute
+ Class Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_fastapi.Job.input
+ runpod.serverless.modules.rp_fastapi.Job.html#input
+ Attribute
+ Class Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_fastapi.TestJob
+ runpod.serverless.modules.rp_fastapi.TestJob.html
+ Class
+ Class
+ PUBLIC
+ Represents a test job. input can be any type of data.
+ -
+
+
runpod.serverless.modules.rp_fastapi.TestJob.id
+ runpod.serverless.modules.rp_fastapi.TestJob.html#id
+ Attribute
+ Class Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_fastapi.TestJob.input
+ runpod.serverless.modules.rp_fastapi.TestJob.html#input
+ Attribute
+ Class Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_fastapi.TestJob.webhook
+ runpod.serverless.modules.rp_fastapi.TestJob.html#webhook
+ Attribute
+ Class Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_fastapi.DefaultRequest
+ runpod.serverless.modules.rp_fastapi.DefaultRequest.html
+ Class
+ Class
+ PUBLIC
+ Represents a test input.
+ -
+
+
runpod.serverless.modules.rp_fastapi.DefaultRequest.input
+ runpod.serverless.modules.rp_fastapi.DefaultRequest.html#input
+ Attribute
+ Class Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_fastapi.DefaultRequest.webhook
+ runpod.serverless.modules.rp_fastapi.DefaultRequest.html#webhook
+ Attribute
+ Class Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_fastapi.JobOutput
+ runpod.serverless.modules.rp_fastapi.JobOutput.html
+ Class
+ Class
+ PUBLIC
+ Represents the output of a job.
+ -
+
+
runpod.serverless.modules.rp_fastapi.JobOutput.id
+ runpod.serverless.modules.rp_fastapi.JobOutput.html#id
+ Attribute
+ Class Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_fastapi.JobOutput.status
+ runpod.serverless.modules.rp_fastapi.JobOutput.html#status
+ Attribute
+ Class Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_fastapi.JobOutput.output
+ runpod.serverless.modules.rp_fastapi.JobOutput.html#output
+ Attribute
+ Class Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_fastapi.JobOutput.error
+ runpod.serverless.modules.rp_fastapi.JobOutput.html#error
+ Attribute
+ Class Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_fastapi.StreamOutput
+ runpod.serverless.modules.rp_fastapi.StreamOutput.html
+ Class
+ Class
+ PUBLIC
+ Stream representation of a job.
+ -
+
+
runpod.serverless.modules.rp_fastapi.StreamOutput.id
+ runpod.serverless.modules.rp_fastapi.StreamOutput.html#id
+ Attribute
+ Class Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_fastapi.StreamOutput.status
+ runpod.serverless.modules.rp_fastapi.StreamOutput.html#status
+ Attribute
+ Class Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_fastapi.StreamOutput.stream
+ runpod.serverless.modules.rp_fastapi.StreamOutput.html#stream
+ Attribute
+ Class Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_fastapi.StreamOutput.error
+ runpod.serverless.modules.rp_fastapi.StreamOutput.html#error
+ Attribute
+ Class Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_fastapi._send_webhook
+ runpod.serverless.modules.rp_fastapi.html#_send_webhook
+ Function
+ Function
+ PRIVATE
+ Sends a webhook to the provided URL.
+ -
+
+
runpod.serverless.modules.rp_fastapi.WorkerAPI
+ runpod.serverless.modules.rp_fastapi.WorkerAPI.html
+ Class
+ Class
+ PUBLIC
+ Used to launch the FastAPI web server when the worker is running in API mode.
+ -
+
+
runpod.serverless.modules.rp_fastapi.WorkerAPI.__init__
+ runpod.serverless.modules.rp_fastapi.WorkerAPI.html#__init__
+ Function
+ Method
+ PUBLIC
+ Initializes the WorkerAPI class.
+ -
+
+
runpod.serverless.modules.rp_fastapi.WorkerAPI.config
+ runpod.serverless.modules.rp_fastapi.WorkerAPI.html#config
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_fastapi.WorkerAPI.rp_app
+ runpod.serverless.modules.rp_fastapi.WorkerAPI.html#rp_app
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_fastapi.WorkerAPI.start_uvicorn
+ runpod.serverless.modules.rp_fastapi.WorkerAPI.html#start_uvicorn
+ Function
+ Method
+ PUBLIC
+ Starts the Uvicorn server.
+ -
+
+
runpod.serverless.modules.rp_fastapi.WorkerAPI._realtime
+ runpod.serverless.modules.rp_fastapi.WorkerAPI.html#_realtime
+ Function
+ Method
+ PRIVATE
+ Performs model inference on the input data using the provided handler. If handler is not provided, returns an error message.
+ -
+
+
runpod.serverless.modules.rp_fastapi.WorkerAPI._sim_run
+ runpod.serverless.modules.rp_fastapi.WorkerAPI.html#_sim_run
+ Function
+ Method
+ PRIVATE
+ Development endpoint to simulate run behavior.
+ -
+
+
runpod.serverless.modules.rp_fastapi.WorkerAPI._sim_runsync
+ runpod.serverless.modules.rp_fastapi.WorkerAPI.html#_sim_runsync
+ Function
+ Method
+ PRIVATE
+ Development endpoint to simulate runsync behavior.
+ -
+
+
runpod.serverless.modules.rp_fastapi.WorkerAPI._sim_stream
+ runpod.serverless.modules.rp_fastapi.WorkerAPI.html#_sim_stream
+ Function
+ Method
+ PRIVATE
+ Development endpoint to simulate stream behavior.
+ -
+
+
runpod.serverless.modules.rp_fastapi.WorkerAPI._sim_status
+ runpod.serverless.modules.rp_fastapi.WorkerAPI.html#_sim_status
+ Function
+ Method
+ PRIVATE
+ Development endpoint to simulate status behavior.
+ -
+
+
runpod.serverless.modules.rp_progress.log
+ runpod.serverless.modules.rp_progress.html#log
+ Attribute
+ Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.modules.rp_progress._create_session_async
+ runpod.serverless.modules.rp_progress.html#_create_session_async
+ Function
+ Function
+ PRIVATE
+ Creates an aiohttp session.
+ -
+
+
runpod.serverless.modules.rp_progress._async_progress_update
+ runpod.serverless.modules.rp_progress.html#_async_progress_update
+ Function
+ Function
+ PRIVATE
+ The actual asynchronous function that sends the update.
+ -
+
+
runpod.serverless.modules.rp_progress._thread_target
+ runpod.serverless.modules.rp_progress.html#_thread_target
+ Function
+ Function
+ PRIVATE
+ A wrapper around _async_progress_update to handle the event loop.
+ -
+
+
runpod.serverless.modules.rp_progress.progress_update
+ runpod.serverless.modules.rp_progress.html#progress_update
+ Function
+ Function
+ PUBLIC
+ Updates the progress of a currently running job in a separate thread.
+ -
+
+
runpod.serverless.log
+ runpod.serverless.html#log
+ Attribute
+ Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.parser
+ runpod.serverless.html#parser
+ Attribute
+ Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless._set_config_args
+ runpod.serverless.html#_set_config_args
+ Function
+ Function
+ PRIVATE
+ Sets the config rp_args, removing any recognized arguments from sys.argv. Returns: config
+ -
+
+
runpod.serverless._get_realtime_port
+ runpod.serverless.html#_get_realtime_port
+ Function
+ Function
+ PRIVATE
+ Get the realtime port from the environment variable if it exists.
+ -
+
+
runpod.serverless._get_realtime_concurrency
+ runpod.serverless.html#_get_realtime_concurrency
+ Function
+ Function
+ PRIVATE
+ Get the realtime concurrency from the environment variable if it exists.
+ -
+
+
runpod.serverless._signal_handler
+ runpod.serverless.html#_signal_handler
+ Function
+ Function
+ PRIVATE
+ Handles the SIGINT signal.
+ -
+
+
runpod.serverless.start
+ runpod.serverless.html#start
+ Function
+ Function
+ PUBLIC
+ Starts the serverless worker.
+ -
+
+
runpod.error.RunPodError
+ runpod.error.RunPodError.html
+ Class
+ Exception
+ PUBLIC
+ Base class for all runpod errors
+ -
+
+
runpod.error.RunPodError.__init__
+ runpod.error.RunPodError.html#__init__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.error.RunPodError.message
+ runpod.error.RunPodError.html#message
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.error.RunPodError.__str__
+ runpod.error.RunPodError.html#__str__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.error.AuthenticationError
+ runpod.error.AuthenticationError.html
+ Class
+ Exception
+ PUBLIC
+ Raised when authentication fails
+ -
+
+
runpod.error.QueryError
+ runpod.error.QueryError.html
+ Class
+ Exception
+ PUBLIC
+ Raised when a GraphQL query fails
+ -
+
+
runpod.error.QueryError.__init__
+ runpod.error.QueryError.html#__init__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.error.QueryError.query
+ runpod.error.QueryError.html#query
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.api.graphql.HTTP_STATUS_UNAUTHORIZED
+ runpod.api.graphql.html#HTTP_STATUS_UNAUTHORIZED
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.api.graphql.run_graphql_query
+ runpod.api.graphql.html#run_graphql_query
+ Function
+ Function
+ PUBLIC
+ Run a GraphQL query
+ -
+
+
runpod.api.mutations.container_register_auth.generate_container_registry_auth
+ runpod.api.mutations.container_register_auth.html#generate_container_registry_auth
+ Function
+ Function
+ PUBLIC
+ Generate a GraphQL mutation string to save container registry authentication details.
+ -
+
+
runpod.api.mutations.endpoints.generate_endpoint_mutation
+ runpod.api.mutations.endpoints.html#generate_endpoint_mutation
+ Function
+ Function
+ PUBLIC
+ Generate a string for a GraphQL mutation to create a new endpoint.
+ -
+
+
runpod.api.mutations.endpoints.update_endpoint_template_mutation
+ runpod.api.mutations.endpoints.html#update_endpoint_template_mutation
+ Function
+ Function
+ PUBLIC
+ Generate a string for a GraphQL mutation to update an existing endpoint's template.
+ -
+
+
runpod.api.mutations.pods.generate_pod_deployment_mutation
+ runpod.api.mutations.pods.html#generate_pod_deployment_mutation
+ Function
+ Function
+ PUBLIC
+ Generates a mutation to deploy a pod on demand.
+ -
+
+
runpod.api.mutations.pods.generate_pod_stop_mutation
+ runpod.api.mutations.pods.html#generate_pod_stop_mutation
+ Function
+ Function
+ PUBLIC
+ Generates a mutation to stop a pod.
+ -
+
+
runpod.api.mutations.pods.generate_pod_resume_mutation
+ runpod.api.mutations.pods.html#generate_pod_resume_mutation
+ Function
+ Function
+ PUBLIC
+ Generates a mutation to resume a pod.
+ -
+
+
runpod.api.mutations.pods.generate_pod_terminate_mutation
+ runpod.api.mutations.pods.html#generate_pod_terminate_mutation
+ Function
+ Function
+ PUBLIC
+ Generates a mutation to terminate a pod.
+ -
+
+
runpod.api.mutations.templates.generate_pod_template
+ runpod.api.mutations.templates.html#generate_pod_template
+ Function
+ Function
+ PUBLIC
+ Generate a string for a GraphQL mutation to create a new pod template.
+ -
+
+
runpod.api.mutations.user.generate_user_mutation
+ runpod.api.mutations.user.html#generate_user_mutation
+ Function
+ Function
+ PUBLIC
+ ' Generates a mutation to edit a user.
+ -
+
+
runpod.api.queries.endpoints.QUERY_ENDPOINT
+ runpod.api.queries.endpoints.html#QUERY_ENDPOINT
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.api.queries.gpus.QUERY_GPU_TYPES
+ runpod.api.queries.gpus.html#QUERY_GPU_TYPES
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.api.queries.gpus.generate_gpu_query
+ runpod.api.queries.gpus.html#generate_gpu_query
+ Function
+ Function
+ PUBLIC
+ Generate a query for a specific GPU type
+ -
+
+
runpod.api.queries.pods.QUERY_POD
+ runpod.api.queries.pods.html#QUERY_POD
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.api.queries.pods.generate_pod_query
+ runpod.api.queries.pods.html#generate_pod_query
+ Function
+ Function
+ PUBLIC
+ Generate a query for a specific GPU type
+ -
+
+
runpod.api.queries.user.QUERY_USER
+ runpod.api.queries.user.html#QUERY_USER
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.api.ctl_commands.get_user
+ runpod.api.ctl_commands.html#get_user
+ Function
+ Function
+ PUBLIC
+ Get the current user
+ -
+
+
runpod.api.ctl_commands.update_user_settings
+ runpod.api.ctl_commands.html#update_user_settings
+ Function
+ Function
+ PUBLIC
+ Update the current user
+ -
+
+
runpod.api.ctl_commands.get_gpus
+ runpod.api.ctl_commands.html#get_gpus
+ Function
+ Function
+ PUBLIC
+ Get all GPU types
+ -
+
+
runpod.api.ctl_commands.get_gpu
+ runpod.api.ctl_commands.html#get_gpu
+ Function
+ Function
+ PUBLIC
+ Get a specific GPU type
+ -
+
+
runpod.api.ctl_commands.get_pods
+ runpod.api.ctl_commands.html#get_pods
+ Function
+ Function
+ PUBLIC
+ Get all pods
+ -
+
+
runpod.api.ctl_commands.get_pod
+ runpod.api.ctl_commands.html#get_pod
+ Function
+ Function
+ PUBLIC
+ Get a specific pod
+ -
+
+
runpod.api.ctl_commands.create_pod
+ runpod.api.ctl_commands.html#create_pod
+ Function
+ Function
+ PUBLIC
+ Create a pod
+ -
+
+
runpod.api.ctl_commands.stop_pod
+ runpod.api.ctl_commands.html#stop_pod
+ Function
+ Function
+ PUBLIC
+ Stop a pod
+ -
+
+
runpod.api.ctl_commands.resume_pod
+ runpod.api.ctl_commands.html#resume_pod
+ Function
+ Function
+ PUBLIC
+ Resume a pod
+ -
+
+
runpod.api.ctl_commands.terminate_pod
+ runpod.api.ctl_commands.html#terminate_pod
+ Function
+ Function
+ PUBLIC
+ Terminate a pod
+ -
+
+
runpod.api.ctl_commands.create_template
+ runpod.api.ctl_commands.html#create_template
+ Function
+ Function
+ PUBLIC
+ Create a template
+ -
+
+
runpod.api.ctl_commands.get_endpoints
+ runpod.api.ctl_commands.html#get_endpoints
+ Function
+ Function
+ PUBLIC
+ Get all endpoints
+ -
+
+
runpod.api.ctl_commands.create_endpoint
+ runpod.api.ctl_commands.html#create_endpoint
+ Function
+ Function
+ PUBLIC
+ Create an endpoint
+ -
+
+
runpod.api.ctl_commands.update_endpoint_template
+ runpod.api.ctl_commands.html#update_endpoint_template
+ Function
+ Function
+ PUBLIC
+ Update an endpoint template
+ -
+
+
runpod.api.ctl_commands.create_container_registry_auth
+ runpod.api.ctl_commands.html#create_container_registry_auth
+ Function
+ Function
+ PUBLIC
+ Create a container registry authentication.
+ -
+
+
runpod.cli.groups.config.functions.CREDENTIAL_FILE
+ runpod.cli.groups.config.functions.html#CREDENTIAL_FILE
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.cli.groups.config.functions.set_credentials
+ runpod.cli.groups.config.functions.html#set_credentials
+ Function
+ Function
+ PUBLIC
+ Sets the user's credentials in ~/.runpod/config.toml If profile already exists user must use `update_credentials` instead.
+ -
+
+
runpod.cli.groups.config.functions.check_credentials
+ runpod.cli.groups.config.functions.html#check_credentials
+ Function
+ Function
+ PUBLIC
+ Checks if the credentials file exists and is valid.
+ -
+
+
runpod.cli.groups.config.functions.get_credentials
+ runpod.cli.groups.config.functions.html#get_credentials
+ Function
+ Function
+ PUBLIC
+ Returns the credentials for the specified profile from ~/.runpod/config.toml
+ -
+
+
runpod.endpoint.helpers.FINAL_STATES
+ runpod.endpoint.helpers.html#FINAL_STATES
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.endpoint.helpers.UNAUTHORIZED_MSG
+ runpod.endpoint.helpers.html#UNAUTHORIZED_MSG
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.endpoint.helpers.API_KEY_NOT_SET_MSG
+ runpod.endpoint.helpers.html#API_KEY_NOT_SET_MSG
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.endpoint.helpers.is_completed
+ runpod.endpoint.helpers.html#is_completed
+ Function
+ Function
+ PUBLIC
+ Returns true if status is one of the possible final states for a serverless request.
+ -
+
+
runpod.endpoint.runner.RunPodClient
+ runpod.endpoint.runner.RunPodClient.html
+ Class
+ Class
+ PUBLIC
+ A client for running endpoint calls.
+ -
+
+
runpod.endpoint.runner.RunPodClient.__init__
+ runpod.endpoint.runner.RunPodClient.html#__init__
+ Function
+ Method
+ PUBLIC
+ Initialize a RunPodClient instance.
+ -
+
+
runpod.endpoint.runner.RunPodClient.rp_session
+ runpod.endpoint.runner.RunPodClient.html#rp_session
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.endpoint.runner.RunPodClient.endpoint_url_base
+ runpod.endpoint.runner.RunPodClient.html#endpoint_url_base
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.endpoint.runner.RunPodClient._request
+ runpod.endpoint.runner.RunPodClient.html#_request
+ Function
+ Method
+ PRIVATE
+ Make a request to the specified endpoint using the given HTTP method.
+ -
+
+
runpod.endpoint.runner.RunPodClient.post
+ runpod.endpoint.runner.RunPodClient.html#post
+ Function
+ Method
+ PUBLIC
+ Post to the endpoint.
+ -
+
+
runpod.endpoint.runner.RunPodClient.get
+ runpod.endpoint.runner.RunPodClient.html#get
+ Function
+ Method
+ PUBLIC
+ Get from the endpoint.
+ -
+
+
runpod.endpoint.runner.Job
+ runpod.endpoint.runner.Job.html
+ Class
+ Class
+ PUBLIC
+ Represents a job to be run on the RunPod service.
+ -
+
+
runpod.endpoint.runner.Job.__init__
+ runpod.endpoint.runner.Job.html#__init__
+ Function
+ Method
+ PUBLIC
+ Initialize a Job instance with the given endpoint ID and job ID.
+ -
+
+
runpod.endpoint.runner.Job.endpoint_id
+ runpod.endpoint.runner.Job.html#endpoint_id
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.endpoint.runner.Job.job_id
+ runpod.endpoint.runner.Job.html#job_id
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.endpoint.runner.Job.rp_client
+ runpod.endpoint.runner.Job.html#rp_client
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.endpoint.runner.Job.job_status
+ runpod.endpoint.runner.Job.html#job_status
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.endpoint.runner.Job.job_output
+ runpod.endpoint.runner.Job.html#job_output
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.endpoint.runner.Job._fetch_job
+ runpod.endpoint.runner.Job.html#_fetch_job
+ Function
+ Method
+ PRIVATE
+ Returns the raw json of the status, raises an exception if invalid
+ -
+
+
runpod.endpoint.runner.Job.status
+ runpod.endpoint.runner.Job.html#status
+ Function
+ Method
+ PUBLIC
+ Returns the status of the job request.
+ -
+
+
runpod.endpoint.runner.Job.output
+ runpod.endpoint.runner.Job.html#output
+ Function
+ Method
+ PUBLIC
+ Returns the output of the job request.
+ -
+
+
runpod.endpoint.runner.Job.stream
+ runpod.endpoint.runner.Job.html#stream
+ Function
+ Method
+ PUBLIC
+ Returns a generator that yields the output of the job request.
+ -
+
+
runpod.endpoint.runner.Job.cancel
+ runpod.endpoint.runner.Job.html#cancel
+ Function
+ Method
+ PUBLIC
+ Cancels the job and returns the result of the cancellation request.
+ -
+
+
runpod.endpoint.runner.Endpoint
+ runpod.endpoint.runner.Endpoint.html
+ Class
+ Class
+ PUBLIC
+ Manages an endpoint to run jobs on the RunPod service.
+ -
+
+
runpod.endpoint.runner.Endpoint.__init__
+ runpod.endpoint.runner.Endpoint.html#__init__
+ Function
+ Method
+ PUBLIC
+ Initialize an Endpoint instance with the given endpoint ID.
+ -
+
+
runpod.endpoint.runner.Endpoint.endpoint_id
+ runpod.endpoint.runner.Endpoint.html#endpoint_id
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.endpoint.runner.Endpoint.rp_client
+ runpod.endpoint.runner.Endpoint.html#rp_client
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.endpoint.runner.Endpoint.run
+ runpod.endpoint.runner.Endpoint.html#run
+ Function
+ Method
+ PUBLIC
+ Run the endpoint with the given input.
+ -
+
+
runpod.endpoint.runner.Endpoint.run_sync
+ runpod.endpoint.runner.Endpoint.html#run_sync
+ Function
+ Method
+ PUBLIC
+ Run the endpoint with the given input synchronously.
+ -
+
+
runpod.endpoint.runner.Endpoint.health
+ runpod.endpoint.runner.Endpoint.html#health
+ Function
+ Method
+ PUBLIC
+ Check the health of the endpoint (number/state of workers, number/state of requests).
+ -
+
+
runpod.endpoint.runner.Endpoint.purge_queue
+ runpod.endpoint.runner.Endpoint.html#purge_queue
+ Function
+ Method
+ PUBLIC
+ Purges the endpoint's job queue and returns the result of the purge request.
+ -
+
+
runpod.endpoint.asyncio.asyncio_runner.Job
+ runpod.endpoint.asyncio.asyncio_runner.Job.html
+ Class
+ Class
+ PUBLIC
+ Class representing a job for an asynchronous endpoint
+ -
+
+
runpod.endpoint.asyncio.asyncio_runner.Job.__init__
+ runpod.endpoint.asyncio.asyncio_runner.Job.html#__init__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.endpoint.asyncio.asyncio_runner.Job.endpoint_id
+ runpod.endpoint.asyncio.asyncio_runner.Job.html#endpoint_id
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.endpoint.asyncio.asyncio_runner.Job.job_id
+ runpod.endpoint.asyncio.asyncio_runner.Job.html#job_id
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.endpoint.asyncio.asyncio_runner.Job.session
+ runpod.endpoint.asyncio.asyncio_runner.Job.html#session
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.endpoint.asyncio.asyncio_runner.Job.endpoint_url_base
+ runpod.endpoint.asyncio.asyncio_runner.Job.html#endpoint_url_base
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.endpoint.asyncio.asyncio_runner.Job.job_status
+ runpod.endpoint.asyncio.asyncio_runner.Job.html#job_status
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.endpoint.asyncio.asyncio_runner.Job.job_output
+ runpod.endpoint.asyncio.asyncio_runner.Job.html#job_output
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.endpoint.asyncio.asyncio_runner.Job._fetch_job
+ runpod.endpoint.asyncio.asyncio_runner.Job.html#_fetch_job
+ Function
+ Method
+ PRIVATE
+ Returns the raw json of the status, reaises an exception if invalid.
+ -
+
+
runpod.endpoint.asyncio.asyncio_runner.Job.status
+ runpod.endpoint.asyncio.asyncio_runner.Job.html#status
+ Function
+ Method
+ PUBLIC
+ Gets jobs' status
+ -
+
+
runpod.endpoint.asyncio.asyncio_runner.Job._wait_for_completion
+ runpod.endpoint.asyncio.asyncio_runner.Job.html#_wait_for_completion
+ Function
+ Method
+ PRIVATE
+ Undocumented
+ -
+
+
runpod.endpoint.asyncio.asyncio_runner.Job.output
+ runpod.endpoint.asyncio.asyncio_runner.Job.html#output
+ Function
+ Method
+ PUBLIC
+ Waits for serverless API job to complete or fail
+ -
+
+
runpod.endpoint.asyncio.asyncio_runner.Job.stream
+ runpod.endpoint.asyncio.asyncio_runner.Job.html#stream
+ Function
+ Method
+ PUBLIC
+ Returns a generator that yields the output of the job request.
+ -
+
+
runpod.endpoint.asyncio.asyncio_runner.Job.cancel
+ runpod.endpoint.asyncio.asyncio_runner.Job.html#cancel
+ Function
+ Method
+ PUBLIC
+ Cancels current job
+ -
+
+
runpod.endpoint.asyncio.asyncio_runner.Endpoint
+ runpod.endpoint.asyncio.asyncio_runner.Endpoint.html
+ Class
+ Class
+ PUBLIC
+ Class for running endpoint
+ -
+
+
runpod.endpoint.asyncio.asyncio_runner.Endpoint.__init__
+ runpod.endpoint.asyncio.asyncio_runner.Endpoint.html#__init__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.endpoint.asyncio.asyncio_runner.Endpoint.endpoint_id
+ runpod.endpoint.asyncio.asyncio_runner.Endpoint.html#endpoint_id
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.endpoint.asyncio.asyncio_runner.Endpoint.endpoint_url
+ runpod.endpoint.asyncio.asyncio_runner.Endpoint.html#endpoint_url
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.endpoint.asyncio.asyncio_runner.Endpoint.session
+ runpod.endpoint.asyncio.asyncio_runner.Endpoint.html#session
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.endpoint.asyncio.asyncio_runner.Endpoint.run
+ runpod.endpoint.asyncio.asyncio_runner.Endpoint.html#run
+ Function
+ Method
+ PUBLIC
+ Runs endpoint with specified input
+ -
+
+
runpod.endpoint.asyncio.asyncio_runner.Endpoint.health
+ runpod.endpoint.asyncio.asyncio_runner.Endpoint.html#health
+ Function
+ Method
+ PUBLIC
+ Checks health of endpoint
+ -
+
+
runpod.endpoint.asyncio.asyncio_runner.Endpoint.purge_queue
+ runpod.endpoint.asyncio.asyncio_runner.Endpoint.html#purge_queue
+ Function
+ Method
+ PUBLIC
+ Purges queue of endpoint
+ -
+
+
runpod.SSH_KEY_PATH
+ index.html#SSH_KEY_PATH
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.profile
+ index.html#profile
+ Attribute
+ Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod._credentials
+ index.html#_credentials
+ Attribute
+ Variable
+ PRIVATE
+ Undocumented
+ -
+
+
runpod.api_key
+ index.html#api_key
+ Attribute
+ Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.api_url_base
+ index.html#api_url_base
+ Attribute
+ Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.endpoint_url_base
+ index.html#endpoint_url_base
+ Attribute
+ Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.cli.groups.ssh.functions.SSH_FILES
+ runpod.cli.groups.ssh.functions.html#SSH_FILES
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.cli.groups.ssh.functions.get_ssh_key_fingerprint
+ runpod.cli.groups.ssh.functions.html#get_ssh_key_fingerprint
+ Function
+ Function
+ PUBLIC
+ Get the fingerprint of an SSH key
+ -
+
+
runpod.cli.groups.ssh.functions.get_user_pub_keys
+ runpod.cli.groups.ssh.functions.html#get_user_pub_keys
+ Function
+ Function
+ PUBLIC
+ Get the current user's SSH keys
+ -
+
+
runpod.cli.groups.ssh.functions.generate_ssh_key_pair
+ runpod.cli.groups.ssh.functions.html#generate_ssh_key_pair
+ Function
+ Function
+ PUBLIC
+ Generate an RSA SSH key pair and save it to disk.
+ -
+
+
runpod.cli.groups.ssh.functions.add_ssh_key
+ runpod.cli.groups.ssh.functions.html#add_ssh_key
+ Function
+ Function
+ PUBLIC
+ Add an SSH public key to the current user's RunPod account. Checks if the key already exists before adding it.
+ -
+
+
runpod.cli.STOP_EVENT
+ runpod.cli.html#STOP_EVENT
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.cli.BASE_DOCKER_IMAGE
+ runpod.cli.html#BASE_DOCKER_IMAGE
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.cli.GPU_TYPES
+ runpod.cli.html#GPU_TYPES
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.cli.ENV_VARS
+ runpod.cli.html#ENV_VARS
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.cli.utils.rp_info.get_pod_ssh_ip_port
+ runpod.cli.utils.rp_info.html#get_pod_ssh_ip_port
+ Function
+ Function
+ PUBLIC
+ Returns the IP and port for SSH access to a pod.
+ -
+
+
runpod.cli.utils.rp_userspace.find_ssh_key_file
+ runpod.cli.utils.rp_userspace.html#find_ssh_key_file
+ Function
+ Function
+ PUBLIC
+ Find the SSH key file that can be used to connect to the pod.
+ -
+
+
runpod.cli.utils.rp_runpodignore.EXCLUDE_PATTERNS
+ runpod.cli.utils.rp_runpodignore.html#EXCLUDE_PATTERNS
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.cli.utils.rp_runpodignore.get_ignore_list
+ runpod.cli.utils.rp_runpodignore.html#get_ignore_list
+ Function
+ Function
+ PUBLIC
+ Reads the .runpodignore file and returns a list of files to ignore.
+ -
+
+
runpod.cli.utils.rp_runpodignore.should_ignore
+ runpod.cli.utils.rp_runpodignore.html#should_ignore
+ Function
+ Function
+ PUBLIC
+ Returns True if the file should be ignored, False otherwise.
+ -
+
+
runpod.cli.utils.ssh_cmd.SSHConnection
+ runpod.cli.utils.ssh_cmd.SSHConnection.html
+ Class
+ Class
+ PUBLIC
+ Connect and run commands over SSH.
+ -
+
+
runpod.cli.utils.ssh_cmd.SSHConnection.__init__
+ runpod.cli.utils.ssh_cmd.SSHConnection.html#__init__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.cli.utils.ssh_cmd.SSHConnection.pod_id
+ runpod.cli.utils.ssh_cmd.SSHConnection.html#pod_id
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.cli.utils.ssh_cmd.SSHConnection.pod_ip
+ runpod.cli.utils.ssh_cmd.SSHConnection.html#pod_ip
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.cli.utils.ssh_cmd.SSHConnection.pod_port
+ runpod.cli.utils.ssh_cmd.SSHConnection.html#pod_port
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.cli.utils.ssh_cmd.SSHConnection.key_file
+ runpod.cli.utils.ssh_cmd.SSHConnection.html#key_file
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.cli.utils.ssh_cmd.SSHConnection.ssh
+ runpod.cli.utils.ssh_cmd.SSHConnection.html#ssh
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.cli.utils.ssh_cmd.SSHConnection.__enter__
+ runpod.cli.utils.ssh_cmd.SSHConnection.html#__enter__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.cli.utils.ssh_cmd.SSHConnection.__exit__
+ runpod.cli.utils.ssh_cmd.SSHConnection.html#__exit__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.cli.utils.ssh_cmd.SSHConnection._get_ssh_options
+ runpod.cli.utils.ssh_cmd.SSHConnection.html#_get_ssh_options
+ Function
+ Method
+ PRIVATE
+ Get the SSH options for connecting to the pod.
+ -
+
+
runpod.cli.utils.ssh_cmd.SSHConnection._signal_handler
+ runpod.cli.utils.ssh_cmd.SSHConnection.html#_signal_handler
+ Function
+ Method
+ PRIVATE
+ Handle signals.
+ -
+
+
runpod.cli.utils.ssh_cmd.SSHConnection.run_commands
+ runpod.cli.utils.ssh_cmd.SSHConnection.html#run_commands
+ Function
+ Method
+ PUBLIC
+ Runs a list of bash commands over SSH.
+ -
+
+
runpod.cli.utils.ssh_cmd.SSHConnection.put_file
+ runpod.cli.utils.ssh_cmd.SSHConnection.html#put_file
+ Function
+ Method
+ PUBLIC
+ Copy local file to remote machine over SSH.
+ -
+
+
runpod.cli.utils.ssh_cmd.SSHConnection.get_file
+ runpod.cli.utils.ssh_cmd.SSHConnection.html#get_file
+ Function
+ Method
+ PUBLIC
+ Fetch a remote file to local machine over SSH.
+ -
+
+
runpod.cli.utils.ssh_cmd.SSHConnection.launch_terminal
+ runpod.cli.utils.ssh_cmd.SSHConnection.html#launch_terminal
+ Function
+ Method
+ PUBLIC
+ Launch an interactive terminal over SSH.
+ -
+
+
runpod.cli.utils.ssh_cmd.SSHConnection.rsync
+ runpod.cli.utils.ssh_cmd.SSHConnection.html#rsync
+ Function
+ Method
+ PUBLIC
+ Sync a local directory to a remote directory over SSH.
+ -
+
+
runpod.cli.utils.ssh_cmd.SSHConnection.close
+ runpod.cli.utils.ssh_cmd.SSHConnection.html#close
+ Function
+ Method
+ PUBLIC
+ Close the SSH connection.
+ -
+
+
runpod.cli.groups.project.helpers.validate_project_name
+ runpod.cli.groups.project.helpers.html#validate_project_name
+ Function
+ Function
+ PUBLIC
+ Validate the project name.
+ -
+
+
runpod.cli.groups.project.helpers.get_project_pod
+ runpod.cli.groups.project.helpers.html#get_project_pod
+ Function
+ Function
+ PUBLIC
+ Check if a project pod exists. Return the pod_id if it exists, else return None.
+ -
+
+
runpod.cli.groups.project.helpers.get_project_endpoint
+ runpod.cli.groups.project.helpers.html#get_project_endpoint
+ Function
+ Function
+ PUBLIC
+ Check if a project endpoint exists. Return the endpoint if it exists, else return None.
+ -
+
+
runpod.cli.groups.project.helpers.copy_template_files
+ runpod.cli.groups.project.helpers.html#copy_template_files
+ Function
+ Function
+ PUBLIC
+ Copy the template files to the destination directory.
+ -
+
+
runpod.cli.groups.project.helpers.attempt_pod_launch
+ runpod.cli.groups.project.helpers.html#attempt_pod_launch
+ Function
+ Function
+ PUBLIC
+ Attempt to launch a pod with the given configuration.
+ -
+
+
runpod.cli.groups.project.helpers.load_project_config
+ runpod.cli.groups.project.helpers.html#load_project_config
+ Function
+ Function
+ PUBLIC
+ Load the project config file.
+ -
+
+
runpod.cli.utils.rp_sync.WatcherHandler
+ runpod.cli.utils.rp_sync.WatcherHandler.html
+ Class
+ Class
+ PUBLIC
+ Watches a directory for changes and syncs them to a remote directory.
+ -
+
+
runpod.cli.utils.rp_sync.WatcherHandler.__init__
+ runpod.cli.utils.rp_sync.WatcherHandler.html#__init__
+ Function
+ Method
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.cli.utils.rp_sync.WatcherHandler.action_function
+ runpod.cli.utils.rp_sync.WatcherHandler.html#action_function
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.cli.utils.rp_sync.WatcherHandler.local_path
+ runpod.cli.utils.rp_sync.WatcherHandler.html#local_path
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.cli.utils.rp_sync.WatcherHandler.ignore_list
+ runpod.cli.utils.rp_sync.WatcherHandler.html#ignore_list
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.cli.utils.rp_sync.WatcherHandler.debouncer
+ runpod.cli.utils.rp_sync.WatcherHandler.html#debouncer
+ Attribute
+ Instance Variable
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.cli.utils.rp_sync.WatcherHandler.on_any_event
+ runpod.cli.utils.rp_sync.WatcherHandler.html#on_any_event
+ Function
+ Method
+ PUBLIC
+ Called on any event.
+ -
+
+
runpod.cli.utils.rp_sync.start_watcher
+ runpod.cli.utils.rp_sync.html#start_watcher
+ Function
+ Function
+ PUBLIC
+ Starts the watcher.
+ -
+
+
runpod.cli.utils.rp_sync.sync_directory
+ runpod.cli.utils.rp_sync.html#sync_directory
+ Function
+ Function
+ PUBLIC
+ Syncs a local directory to a remote directory.
+ -
+
+
runpod.cli.groups.project.functions.STARTER_TEMPLATES
+ runpod.cli.groups.project.functions.html#STARTER_TEMPLATES
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.cli.groups.project.functions._launch_dev_pod
+ runpod.cli.groups.project.functions.html#_launch_dev_pod
+ Function
+ Function
+ PRIVATE
+ Launch a development pod.
+ -
+
+
runpod.cli.groups.project.functions.create_new_project
+ runpod.cli.groups.project.functions.html#create_new_project
+ Function
+ Function
+ PUBLIC
+ Create a new project.
+ -
+
+
runpod.cli.groups.project.functions.start_project
+ runpod.cli.groups.project.functions.html#start_project
+ Function
+ Function
+ PUBLIC
+ Start the project development environment from runpod.toml
+ -
+
+
runpod.cli.groups.project.functions.create_project_endpoint
+ runpod.cli.groups.project.functions.html#create_project_endpoint
+ Function
+ Function
+ PUBLIC
+ Create a project endpoint.
+ -
+
+
runpod.cli.groups.project.commands.project_cli
+ runpod.cli.groups.project.commands.html#project_cli
+ Function
+ Function
+ PUBLIC
+ Create and deploy projects on RunPod.
+ -
+
+
runpod.cli.groups.project.commands.new_project_wizard
+ runpod.cli.groups.project.commands.html#new_project_wizard
+ Function
+ Function
+ PUBLIC
+ Create a new project.
+ -
+
+
runpod.cli.groups.project.commands.start_project_pod
+ runpod.cli.groups.project.commands.html#start_project_pod
+ Function
+ Function
+ PUBLIC
+ Start the project development pod from runpod.toml
+ -
+
+
runpod.cli.groups.project.commands.deploy_project
+ runpod.cli.groups.project.commands.html#deploy_project
+ Function
+ Function
+ PUBLIC
+ Deploy the project to RunPod.
+ -
+
+
runpod.cli.groups.config.commands.config_wizard
+ runpod.cli.groups.config.commands.html#config_wizard
+ Function
+ Function
+ PUBLIC
+ Starts the configuration wizard to set up the RunPod CLI. If credentials are already set, prompts the user to overwrite them.
+ -
+
+
runpod.cli.groups.ssh.commands.ssh_cli
+ runpod.cli.groups.ssh.commands.html#ssh_cli
+ Function
+ Function
+ PUBLIC
+ Manage and configure SSH keys.
+ -
+
+
runpod.cli.groups.ssh.commands.list_keys
+ runpod.cli.groups.ssh.commands.html#list_keys
+ Function
+ Function
+ PUBLIC
+ Lists the SSH keys for the current user.
+ -
+
+
runpod.cli.groups.ssh.commands.add_key
+ runpod.cli.groups.ssh.commands.html#add_key
+ Function
+ Function
+ PUBLIC
+ Adds an SSH key to the current user account. If no key is provided, one will be generated.
+ -
+
+
runpod.cli.groups.pod.commands.pod_cli
+ runpod.cli.groups.pod.commands.html#pod_cli
+ Function
+ Function
+ PUBLIC
+ A collection of CLI functions for Pod.
+ -
+
+
runpod.cli.groups.pod.commands.list_pods
+ runpod.cli.groups.pod.commands.html#list_pods
+ Function
+ Function
+ PUBLIC
+ Lists the pods for the current user.
+ -
+
+
runpod.cli.groups.pod.commands.create_new_pod
+ runpod.cli.groups.pod.commands.html#create_new_pod
+ Function
+ Function
+ PUBLIC
+ Creates a pod.
+ -
+
+
runpod.cli.groups.pod.commands.connect_to_pod
+ runpod.cli.groups.pod.commands.html#connect_to_pod
+ Function
+ Function
+ PUBLIC
+ Connects to a pod.
+ -
+
+
runpod.cli.groups.exec.functions.python_over_ssh
+ runpod.cli.groups.exec.functions.html#python_over_ssh
+ Function
+ Function
+ PUBLIC
+ Runs a Python file over SSH.
+ -
+
+
runpod.cli.groups.exec.helpers.POD_ID_FILE
+ runpod.cli.groups.exec.helpers.html#POD_ID_FILE
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.cli.groups.exec.helpers.get_session_pod
+ runpod.cli.groups.exec.helpers.html#get_session_pod
+ Function
+ Function
+ PUBLIC
+ Returns the pod_id for the current session.
+ -
+
+
runpod.cli.groups.exec.commands.exec_cli
+ runpod.cli.groups.exec.commands.html#exec_cli
+ Function
+ Function
+ PUBLIC
+ A collection of CLI functions for Exec.
+ -
+
+
runpod.cli.groups.exec.commands.remote_python
+ runpod.cli.groups.exec.commands.html#remote_python
+ Function
+ Function
+ PUBLIC
+ Runs a remote Python shell.
+ -
+
+
runpod.cli.entry.runpod_cli
+ runpod.cli.entry.html#runpod_cli
+ Function
+ Function
+ PUBLIC
+ A collection of CLI functions for RunPod.
+ -
+
+
runpod.serverless.utils.rp_cleanup.clean
+ runpod.serverless.utils.rp_cleanup.html#clean
+ Function
+ Function
+ PUBLIC
+ Removes the downloads folder.
+ -
+
+
runpod.serverless.utils.rp_cuda.is_available
+ runpod.serverless.utils.rp_cuda.html#is_available
+ Function
+ Function
+ PUBLIC
+ Returns True if CUDA is available, False otherwise.
+ -
+
+
runpod.serverless.utils.rp_validator.UNEXPECTED_INPUT_ERROR
+ runpod.serverless.utils.rp_validator.html#UNEXPECTED_INPUT_ERROR
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.utils.rp_validator.MISSING_REQUIRED_ERROR
+ runpod.serverless.utils.rp_validator.html#MISSING_REQUIRED_ERROR
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.utils.rp_validator.MISSING_DEFAULT_ERROR
+ runpod.serverless.utils.rp_validator.html#MISSING_DEFAULT_ERROR
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.utils.rp_validator.MISSING_TYPE_ERROR
+ runpod.serverless.utils.rp_validator.html#MISSING_TYPE_ERROR
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.utils.rp_validator.INVALID_TYPE_ERROR
+ runpod.serverless.utils.rp_validator.html#INVALID_TYPE_ERROR
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.utils.rp_validator.CONSTRAINTS_ERROR
+ runpod.serverless.utils.rp_validator.html#CONSTRAINTS_ERROR
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.utils.rp_validator.SCHEMA_ERROR
+ runpod.serverless.utils.rp_validator.html#SCHEMA_ERROR
+ Attribute
+ Constant
+ PUBLIC
+ Undocumented
+ -
+
+
runpod.serverless.utils.rp_validator._add_error
+ runpod.serverless.utils.rp_validator.html#_add_error
+ Function
+ Function
+ PRIVATE
+ Undocumented
+ -
+
+
runpod.serverless.utils.rp_validator._check_for_unexpected_inputs
+ runpod.serverless.utils.rp_validator.html#_check_for_unexpected_inputs
+ Function
+ Function
+ PRIVATE
+ Undocumented
+ -
+
+
runpod.serverless.utils.rp_validator._validate_and_transform_schema_items
+ runpod.serverless.utils.rp_validator.html#_validate_and_transform_schema_items
+ Function
+ Function
+ PRIVATE
+ Undocumented
+ -
+
+
runpod.serverless.utils.rp_validator._validate_required_inputs_and_set_defaults
+ runpod.serverless.utils.rp_validator.html#_validate_required_inputs_and_set_defaults
+ Function
+ Function
+ PRIVATE
+ Undocumented
+ -
+
+
runpod.serverless.utils.rp_validator._validate_input_against_schema
+ runpod.serverless.utils.rp_validator.html#_validate_input_against_schema
+ Function
+ Function
+ PRIVATE
+ Undocumented
+ -
+
+
runpod.serverless.utils.rp_validator.validate
+ runpod.serverless.utils.rp_validator.html#validate
+ Function
+ Function
+ PUBLIC
+ Validates the input. Checks to see if the provided inputs match the expected types. Checks to see if the required inputs are included. Sets the default values for the inputs that are not provided. Validates the inputs using the lambda constraints.
+
+