Added predict documentation but unsure

CerebriumAI · Nov 22, 2023 · 11516fa · 11516fa
1 parent 515a761
commit 11516fa
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/cerebrium/environments/initial-setup.mdx b/cerebrium/environments/initial-setup.mdx
@@ -51,6 +51,9 @@ The parameters for your config file are the same as those which you would use as
 | `min_replicas`      | The minimum number of replicas to run.                                                          | int     | 0                                                                  |
 | `max_replicas`      | The maximum number of replicas to scale to.                                                     | int     | \*plan limit                                                       |
 | `cooldown`          | The number of seconds to keep your model warm after each request. It resets after every request | int     | 60                                                                 |
+| `predict-data`      | A JSON object for you to test inference on your endpoint when a deployment is made              | json    | {}                                                                 |
+| `disable-predict`   | Whether to disable testing your predict function with input                                     | boolean | false                                                              |
+
 
 ## Config File Example
 
@@ -67,4 +70,6 @@ disable_animation: false
 python_version: 3.9
 min_replicas: 0
 max_replicas: 30
+predict_data: '{"prompt": "The quick brown fox jumps over the lazy dog"}'
+disable-predict: false
 ```
diff --git a/cerebrium/getting-started/quickstart.mdx b/cerebrium/getting-started/quickstart.mdx
@@ -32,7 +32,7 @@ def predict(item, run_id, logger):
 
     # Do something with parameters from item
 
-    return {"key": "value}
+    return {"key": "value"}
 ```
 
 The Item class is where you define the parameters your model receives as well as their type. Item needs to inherit from BaseModel which uses Pydantic to validate request schemas.