Paperspace allows you to tailor your deployment via configuration definitions.
apiVersion: v1 # required, defaults to v1
name: my cool deployment # the name of your deployment. This must be unique within your project.
enabled: true # Toggle to enable or disable the app
containerRegistry: my-registry # (optional) name of the container registry to use for the app.
command: # command to run on startup
replicas: 2 # amount of static replicas for your app. We recommend 2 to ensure high availability.
enabled: true # toggle for enabling/disabling autoscaling
maxReplicas: 5 # max replicas for autoscaling
- metric: cpu
value: 50 # 50% cpu utilization across all replicas
- metric: memory
value: 22 # 22% memory utilization across all replicas
- metric: requestDuration
value: 2 # 2 second request duration for the endpoint
integrations: # List of integrations. Max is 5.
- type: git-lfs # git-lfs integration type
name: falcon # unique name of the integration
path: /models/ # the a unique path on the filesystem to mount the integration. In this spec, model files will be located at /models/falcon
url: https://huggingface.co/tiiuae/falcon-7b # hugging face model url for cloning
- type: s3 # s3 integration type
secretAccessKey: secret:secretAccessKey # stored as a project or team secret. Naming is arbitrary.
healthChecks: # health checks allow you to define a set of probes to check the health of your app
port: 8000 # healthcheck port.
headers: # (optional) list of headers to pass to the readiness probe
- name: Authorization
env: # container environment variables
- name: some-env
- name: secret-env
value: secret:mySecretEnv # stored as a project or team secret. Naming is arbitrary.
Common configuration actions
These are actions you can take by updating the deployment spec either through the console or the CLI/SDK.
- Start and stop the Deployment: Set
false(off) and resubmit the spec
- Update the number of replicas: Change
replicasto the desired number of replicas and resubmit the spec
- Change the machine type or image: Update the
imagerespectively and resubmit the spec