Skip to content

Commit

Permalink
docs: fix typo
Browse files Browse the repository at this point in the history
Signed-off-by: Han Xiao <[email protected]>
  • Loading branch information
hanxiao committed Oct 25, 2024
1 parent ce97c32 commit 0009e7a
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 14 deletions.
10 changes: 5 additions & 5 deletions docs/concepts/orchestration/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,7 @@ In this case, the Deployment can be stopped by interrupting the thread or proces
Alternatively, a `multiprocessing` or `threading` `Event` object can be passed to `.block()`, which stops the Deployment once set.

```python
from jina-serve import Deployment
from jina import Deployment
import threading


Expand Down Expand Up @@ -301,7 +301,7 @@ A Deployment YAML can be exported as a Docker Compose YAML or Kubernetes YAML bu

````{tab} Python
```python
from jina-serve import Deployment
from jina import Deployment
dep = Deployment()
dep.to_docker_compose_yaml()
Expand All @@ -322,7 +322,7 @@ For advanced utilization of Docker Compose with Jina-serve, refer to {ref}`How t

````{tab} Python
```python
from jina-serve import Deployment
from jina import Deployment
dep = Deployment
dep.to_kubernetes_yaml('dep_k8s_configuration')
Expand Down Expand Up @@ -381,7 +381,7 @@ The logging configuration can be used as follows:
````{tab} Python
```python
from jina-serve import Deployment
from jina import Deployment

dep = Deployment(log_config='./logging.json.yml')
```
Expand All @@ -408,7 +408,7 @@ gRPC is the default protocol used by a Deployment to expose Executors to the out
HTTP can be used for a stand-alone Deployment (without being part of a Flow), which allows external services to connect via REST.

```python
from jina-serve import Deployment, Executor, requests
from jina import Deployment, Executor, requests
from docarray import DocList
from docarray.documents import TextDoc

Expand Down
2 changes: 1 addition & 1 deletion docs/concepts/orchestration/flow.md
Original file line number Diff line number Diff line change
Expand Up @@ -434,7 +434,7 @@ More Flow YAML specifications can be found in {ref}`Flow YAML Specification<flow
Let's understand how Executors process Documents's inside a Flow, and how changes are chained and applied, affecting downstream Executors in the Flow.

```python
from jina-serve import Executor, requests, Flow
from jina import Executor, requests, Flow
from docarray import DocList, BaseDoc
from docarray.documents import TextDoc
Expand Down
4 changes: 2 additions & 2 deletions docs/concepts/orchestration/readiness.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ True

`````{tab} Deployment
```python
from jina-serve import Deployment
from jina import Deployment
dep = Deployment(port=12345)
Expand Down Expand Up @@ -156,7 +156,7 @@ WARNI… Jina-serve@92986 message lost 100% (3/3)
`````
`````{tab} Flow
```python
from jina-serve import Flow
from jina import Flow
f = Flow(port=12345)
Expand Down
2 changes: 1 addition & 1 deletion docs/concepts/serving/executor/add-endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ from jina import requests
{class}`~jina.requests` takes an optional `on=` parameter, which binds the decorated method to the specified route:

```python
from jina-serve import Executor, requests
from jina import Executor, requests
import asyncio


Expand Down
4 changes: 2 additions & 2 deletions docs/concepts/serving/executor/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ MyExecutor/

- `executor.py` contains your Executor's main logic. The command should generate the following boilerplate code:
```python
from jina-serve import Executor, requests
from jina import Executor, requests
from docarray import DocList, BaseDoc

class MyExecutor(Executor):
Expand All @@ -60,7 +60,7 @@ If your Executor has `__init__`, it needs to carry `**kwargs` in the signature a
in the body:

```python
from jina-serve import Executor
from jina import Executor


class MyExecutor(Executor):
Expand Down
6 changes: 3 additions & 3 deletions docs/get-started/create-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ emphasize-lines: 13-16
import numpy as np
import torch
from jina-serve import Executor, requests
from jina import Executor, requests
class MyExecutor(Executor):
Expand All @@ -163,7 +163,7 @@ Kill the last server with `Ctrl-C` and restart the server with `jina flow --uses
Modify `client.py` to call the `/crunch-numbers` endpoint:

```python
from jina-serve import Client
from jina import Client
from docarray import DocList
from docarray.documents.legacy import LegacyDocument

Expand Down Expand Up @@ -245,7 +245,7 @@ Now change the Client's code to use the deployed endpoint shown above:
---
emphasize-lines: 6
---
from jina-serve import Client
from jina import Client
from docarray import DocList
from docarray.documents.legacy import LegacyDocument
Expand Down

0 comments on commit 0009e7a

Please sign in to comment.