Skip to content

Commit

Permalink
fix(docs): Use consistent shell style (#5133)
Browse files Browse the repository at this point in the history
I noticed the lack of spaces. There's also a fix where a closing
apostrophe was missing.

I've also improved some of the phrasing.
  • Loading branch information
jesse-c authored Sep 18, 2023
1 parent 47d1a85 commit bd08dc0
Show file tree
Hide file tree
Showing 18 changed files with 57 additions and 58 deletions.
13 changes: 6 additions & 7 deletions docs/source/contents/cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,13 @@ These defaults will be correct when Seldon Core v2 is installed locally as per t

### Inference Service

For a default install into the `seldon-mesh` namespace if you have exposed the inference svc as a loadbalancer you will find it at:
For a default install into the `seldon-mesh` namespace if you have exposed the inference `svc` as a loadbalancer you will find it at:

```
kubectl get svc seldon-mesh -n seldon-mesh -o jsonpath='{.status.loadBalancer.ingress[0].ip}'
```

So use above ip at port 80:
Use above IP at port 80:

```
export SELDON_INFER_HOST=<ip>:80
Expand All @@ -51,18 +51,18 @@ export SELDON_INFER_HOST=<ip>:80
For a default install into the `seldon-mesh` namespace if you have exposed the scheduler svc as a loadbalancer you will find it at:

```
kubectl get svc seldon-scheduler -n seldon-mesh -o jsonpath='{.status.loadBalancer.ingress[0].ip}
kubectl get svc seldon-scheduler -n seldon-mesh -o jsonpath='{.status.loadBalancer.ingress[0].ip}'
```

So use above ip at port 9000:
Use above IP at port 9004:

```
export SELDON_SCHEDULE_HOST=<ip>:80
export SELDON_SCHEDULE_HOST=<ip>:9004
```

### Kafka Broker

The kafka broker will depend on how you have installed Kafka into your Kubernetes cluster. Find the broker IP and use
The Kafka broker will depend on how you have installed Kafka into your Kubernetes cluster. Find the broker IP and use:

```
export SELDON_KAFKA_BROKER=<ip>:<port>
Expand Down Expand Up @@ -183,4 +183,3 @@ docs/seldon_pipeline_unload.md
docs/seldon_pipeline_inspect.md
docs/seldon_server_status.md
```

4 changes: 2 additions & 2 deletions samples/examples/huggingface/huggingface.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -472,7 +472,7 @@
}
],
"source": [
"!seldon pipeline status sentiment-explain -w PipelineReady| jq -M ."
"!seldon pipeline status sentiment-explain -w PipelineReady | jq -M ."
]
},
{
Expand Down Expand Up @@ -662,7 +662,7 @@
}
],
"source": [
"!seldon pipeline status speech-to-sentiment -w PipelineReady| jq -M ."
"!seldon pipeline status speech-to-sentiment -w PipelineReady | jq -M ."
]
},
{
Expand Down
4 changes: 2 additions & 2 deletions samples/examples/huggingface/huggingface.md
Original file line number Diff line number Diff line change
Expand Up @@ -294,7 +294,7 @@ seldon pipeline load -f ../../pipelines/sentiment-explain.yaml
```

```bash
seldon pipeline status sentiment-explain -w PipelineReady| jq -M .
seldon pipeline status sentiment-explain -w PipelineReady | jq -M .
```

```json
Expand Down Expand Up @@ -414,7 +414,7 @@ seldon pipeline load -f ../../pipelines/speech-to-sentiment.yaml
```

```bash
seldon pipeline status speech-to-sentiment -w PipelineReady| jq -M .
seldon pipeline status speech-to-sentiment -w PipelineReady | jq -M .
```

```json
Expand Down
2 changes: 1 addition & 1 deletion samples/examples/image_classifier/infer.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -366,7 +366,7 @@
}
],
"source": [
"!seldon pipeline status cifar10-production -w PipelineReady| jq -M ."
"!seldon pipeline status cifar10-production -w PipelineReady | jq -M ."
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion samples/examples/image_classifier/infer.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ seldon pipeline load -f ../../pipelines/cifar10.yaml
```

```bash
seldon pipeline status cifar10-production -w PipelineReady| jq -M .
seldon pipeline status cifar10-production -w PipelineReady | jq -M .
```

```json
Expand Down
2 changes: 1 addition & 1 deletion samples/examples/income_classifier/infer.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,7 @@
}
],
"source": [
"!seldon pipeline status income-production -w PipelineReady| jq -M ."
"!seldon pipeline status income-production -w PipelineReady | jq -M ."
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion samples/examples/income_classifier/infer.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ seldon pipeline load -f ../../pipelines/income.yaml
```

```bash
seldon pipeline status income-production -w PipelineReady| jq -M .
seldon pipeline status income-production -w PipelineReady | jq -M .
```

```json
Expand Down
2 changes: 1 addition & 1 deletion samples/examples/income_classifier/infer_local.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@
}
],
"source": [
"!seldon pipeline status income-production -w PipelineReady| jq -M ."
"!seldon pipeline status income-production -w PipelineReady | jq -M ."
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion samples/examples/income_classifier/infer_local.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ seldon pipeline load -f ../../pipelines/income.yaml
```

```bash
seldon pipeline status income-production -w PipelineReady| jq -M .
seldon pipeline status income-production -w PipelineReady | jq -M .
```

```json
Expand Down
2 changes: 1 addition & 1 deletion samples/pipeline-errors.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@
}
],
"source": [
"!seldon pipeline status tfsimples -w PipelineReady| jq -M ."
"!seldon pipeline status tfsimples -w PipelineReady | jq -M ."
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion samples/pipeline-errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ seldon pipeline load -f ./pipelines/tfsimples.yaml
```

```bash
seldon pipeline status tfsimples -w PipelineReady| jq -M .
seldon pipeline status tfsimples -w PipelineReady | jq -M .
```

```json
Expand Down
4 changes: 2 additions & 2 deletions samples/pipeline-examples.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@
}
],
"source": [
"!seldon pipeline status tfsimples -w PipelineReady| jq -M ."
"!seldon pipeline status tfsimples -w PipelineReady | jq -M ."
]
},
{
Expand Down Expand Up @@ -684,7 +684,7 @@
}
],
"source": [
"!seldon pipeline status tfsimples-input -w PipelineReady| jq -M ."
"!seldon pipeline status tfsimples-input -w PipelineReady | jq -M ."
]
},
{
Expand Down
4 changes: 2 additions & 2 deletions samples/pipeline-examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ seldon pipeline load -f ./pipelines/tfsimples.yaml
```

```bash
seldon pipeline status tfsimples -w PipelineReady| jq -M .
seldon pipeline status tfsimples -w PipelineReady | jq -M .
```

```json
Expand Down Expand Up @@ -452,7 +452,7 @@ seldon pipeline load -f ./pipelines/tfsimples-input.yaml
```

```bash
seldon pipeline status tfsimples-input -w PipelineReady| jq -M .
seldon pipeline status tfsimples-input -w PipelineReady | jq -M .
```

```json
Expand Down
38 changes: 19 additions & 19 deletions samples/pipeline-tests.sh
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
seldon model load -f ./models/tfsimple1.yaml
seldon model load -f ./models/tfsimple2.yaml
seldon model load -f ./models/tfsimple1.yaml
seldon model load -f ./models/tfsimple2.yaml
seldon model status tfsimple1 -w ModelAvailable | jq -M .
seldon model status tfsimple2 -w ModelAvailable | jq -M .
seldon pipeline load -f ./pipelines/tfsimples.yaml
seldon pipeline status tfsimples -w PipelineReady| jq -M .
seldon pipeline status tfsimples -w PipelineReady | jq -M .
seldon pipeline infer tfsimples '{"inputs":[{"name":"INPUT0","data":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16],"datatype":"INT32","shape":[1,16]},{"name":"INPUT1","data":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16],"datatype":"INT32","shape":[1,16]}]}'
seldon pipeline infer tfsimples --inference-mode grpc '{"model_name":"simple","inputs":[{"name":"INPUT0","contents":{"int_contents":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16]},"datatype":"INT32","shape":[1,16]},{"name":"INPUT1","contents":{"int_contents":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16]},"datatype":"INT32","shape":[1,16]}]}'
seldon pipeline unload tfsimples
seldon model unload tfsimple1
seldon model unload tfsimple2


seldon model load -f ./models/tfsimple1.yaml
seldon model load -f ./models/tfsimple2.yaml
seldon model load -f ./models/tfsimple3.yaml
seldon model load -f ./models/tfsimple1.yaml
seldon model load -f ./models/tfsimple2.yaml
seldon model load -f ./models/tfsimple3.yaml
seldon model status tfsimple1 -w ModelAvailable | jq -M .
seldon model status tfsimple2 -w ModelAvailable | jq -M .
seldon model status tfsimple3 -w ModelAvailable | jq -M .
Expand All @@ -25,9 +25,9 @@ seldon model unload tfsimple1
seldon model unload tfsimple2
seldon model unload tfsimple3

seldon model load -f ./models/conditional.yaml
seldon model load -f ./models/add10.yaml
seldon model load -f ./models/mul10.yaml
seldon model load -f ./models/conditional.yaml
seldon model load -f ./models/add10.yaml
seldon model load -f ./models/mul10.yaml
seldon model status conditional -w ModelAvailable | jq -M .
seldon model status add10 -w ModelAvailable | jq -M .
seldon model status mul10 -w ModelAvailable | jq -M .
Expand All @@ -41,20 +41,20 @@ seldon model unload add10
seldon model unload mul10


seldon model load -f ./models/outlier-error.yaml
seldon model load -f ./models/outlier-error.yaml
seldon model status outlier-error -w ModelAvailable | jq -M .
seldon pipeline load -f ./pipelines/error.yaml
seldon pipeline status error -w PipelineReady | jq -M .
seldon pipeline infer error --inference-mode grpc '{"model_name":"outlier","inputs":[{"name":"INPUT","contents":{"fp32_contents":[1,2,3,4]},"datatype":"FP32","shape":[4]}]}'
seldon pipeline infer error --inference-mode grpc '{"model_name":"outlier","inputs":[{"name":"INPUT","contents":{"fp32_contents":[100,2,3,4]},"datatype":"FP32","shape":[4]}]}'
seldon pipeline infer error --inference-mode grpc '{"model_name":"outlier","inputs":[{"name":"INPUT","contents":{"fp32_contents":[100,2,3,4]},"datatype":"FP32","shape":[4]}]}'
seldon pipeline unload error
seldon model unload outlier-error


seldon model load -f ./models/tfsimple1.yaml
seldon model load -f ./models/tfsimple2.yaml
seldon model load -f ./models/tfsimple3.yaml
seldon model load -f ./models/check.yaml
seldon model load -f ./models/tfsimple1.yaml
seldon model load -f ./models/tfsimple2.yaml
seldon model load -f ./models/tfsimple3.yaml
seldon model load -f ./models/check.yaml
seldon model status tfsimple1 -w ModelAvailable | jq -M .
seldon model status tfsimple2 -w ModelAvailable | jq -M .
seldon model status tfsimple3 -w ModelAvailable | jq -M .
Expand All @@ -70,8 +70,8 @@ seldon model unload tfsimple3
seldon model unload check


seldon model load -f ./models/mul10.yaml
seldon model load -f ./models/add10.yaml
seldon model load -f ./models/mul10.yaml
seldon model load -f ./models/add10.yaml
seldon model status mul10 -w ModelAvailable | jq -M .
seldon model status add10 -w ModelAvailable | jq -M .
seldon pipeline load -f ./pipelines/pipeline-inputs.yaml
Expand All @@ -82,8 +82,8 @@ seldon model unload mul10
seldon model unload add10


seldon model load -f ./models/mul10.yaml
seldon model load -f ./models/add10.yaml
seldon model load -f ./models/mul10.yaml
seldon model load -f ./models/add10.yaml
seldon model status mul10 -w ModelAvailable | jq -M .
seldon model status add10 -w ModelAvailable | jq -M .
seldon pipeline load -f ./pipelines/trigger-joins.yaml
Expand Down
14 changes: 7 additions & 7 deletions samples/pipeline-to-pipeline.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@
}
],
"source": [
"!seldon pipeline status tfsimple -w PipelineReady| jq -M ."
"!seldon pipeline status tfsimple -w PipelineReady | jq -M ."
]
},
{
Expand Down Expand Up @@ -356,7 +356,7 @@
}
],
"source": [
"!seldon pipeline status tfsimple-extended -w PipelineReady| jq -M ."
"!seldon pipeline status tfsimple-extended -w PipelineReady | jq -M ."
]
},
{
Expand Down Expand Up @@ -665,7 +665,7 @@
}
],
"source": [
"!seldon pipeline status tfsimple -w PipelineReady| jq -M ."
"!seldon pipeline status tfsimple -w PipelineReady | jq -M ."
]
},
{
Expand Down Expand Up @@ -1201,7 +1201,7 @@
}
],
"source": [
"!seldon pipeline status tfsimple -w PipelineReady| jq -M ."
"!seldon pipeline status tfsimple -w PipelineReady | jq -M ."
]
},
{
Expand Down Expand Up @@ -1746,7 +1746,7 @@
}
],
"source": [
"!seldon pipeline status tfsimple -w PipelineReady| jq -M ."
"!seldon pipeline status tfsimple -w PipelineReady | jq -M ."
]
},
{
Expand Down Expand Up @@ -1928,7 +1928,7 @@
}
],
"source": [
"!seldon pipeline status tfsimple-extended-step -w PipelineReady| jq -M ."
"!seldon pipeline status tfsimple-extended-step -w PipelineReady | jq -M ."
]
},
{
Expand Down Expand Up @@ -2263,7 +2263,7 @@
}
],
"source": [
"!seldon pipeline status tfsimple -w PipelineReady| jq -M ."
"!seldon pipeline status tfsimple -w PipelineReady | jq -M ."
]
},
{
Expand Down
Loading

0 comments on commit bd08dc0

Please sign in to comment.