Skip to content

Commit 7de22a8

Browse files
committed
Update python client docs version comment
1 parent 755e09c commit 7de22a8

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

dev/generate_python_client_md.sh

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,4 +60,8 @@ sed -i "s/#### /## /g" $ROOT/docs/miscellaneous/python-client.md
6060
sed -i 's/[[:space:]]*$//' $ROOT/docs/miscellaneous/python-client.md
6161
truncate -s -1 $ROOT/docs/miscellaneous/python-client.md
6262

63+
# Cortex version comment
64+
sed -i "s/^## deploy/## deploy\n\n<!-- CORTEX_VERSION_MINOR x5 -->/g" $ROOT/docs/miscellaneous/python-client.md
65+
6366
pip3 uninstall -y cortex
67+
rm -rf $ROOT/pkg/workloads/cortex/client/cortex.egg-info

docs/miscellaneous/python-client.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,8 @@ Delete an environment configured on this machine.
104104

105105
## deploy
106106

107+
<!-- CORTEX_VERSION_MINOR x5 -->
108+
107109
```python
108110
| deploy(api_spec: dict, predictor=None, pip_dependencies=[], conda_dependencies=[], project_dir: Optional[str] = None, force: bool = False, wait: bool = False) -> list
109111
```
@@ -119,8 +121,8 @@ Deploy an API.
119121
- `predictor` - A Cortex Predictor class implementation. Not required when deploying a traffic splitter.
120122
→ Realtime API: https://docs.cortex.dev/v/master/deployments/realtime-api/predictors
121123
→ Batch API: https://docs.cortex.dev/v/master/deployments/batch-api/predictors
122-
- `pip_dependencies` - A list of PyPI dependencies that will be installed before running your predictor class.
123-
- `conda_dependencies` - A list of Conda dependencies that will be installed before running your predictor class.
124+
- `pip_dependencies` - A list of PyPI dependencies that will be installed before the predictor class implementation is invoked.
125+
- `conda_dependencies` - A list of Conda dependencies that will be installed before the predictor class implementation is invoked.
124126
- `project_dir` - Path to a python project.
125127
- `force` - Override any in-progress api updates.
126128
- `wait` - Streams logs until the APIs are ready.

0 commit comments

Comments
 (0)