Skip to content

Commit 99f4384

Browse files
committed
docs: fix typo
Signed-off-by: Han Xiao <[email protected]>
1 parent 0009e7a commit 99f4384

File tree

15 files changed

+67
-67
lines changed

15 files changed

+67
-67
lines changed

docs/cloud-nativeness/k8s.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ The export function {meth}`~jina.Deployment.to_kubernetes_yaml` and {meth}`~jina
4747
```
4848
````{admonition} Matching Jina versions
4949
:class: caution
50-
If you change the Docker images for {class}`~jina-serve.Executor` and {class}`~jina-serve.Gateway` in your Kubernetes-generated file, ensure that all of them are built with the same Jina-serve version to guarantee compatibility.
50+
If you change the Docker images for {class}`~jina.Executor` and {class}`~jina.Gateway` in your Kubernetes-generated file, ensure that all of them are built with the same Jina-serve version to guarantee compatibility.
5151
````
5252

5353
You can't add basic Kubernetes features like `Secrets`, `ConfigMap` or `Labels` via the Pythonic or YAML interface. This is intentional and doesn't mean that we don't support these features. On the contrary, we let you fully express your Kubernetes configuration by using the Kubernetes API to add your own Kubernetes standard to Jina-serve.
@@ -129,7 +129,7 @@ This can be done in a Pythonic way or in YAML:
129129

130130
````{tab} Using Python
131131
132-
You can use {meth}`~jina-serve.Flow.config_gateway` to add `replicas` parameter
132+
You can use {meth}`~jina.Flow.config_gateway` to add `replicas` parameter
133133
```python
134134
from jina import Flow
135135
@@ -161,6 +161,6 @@ You can use a custom Docker image for the Gateway deployment by setting the envi
161161
## See also
162162
- {ref}`Step by step deployment of a Jina-serve Flow on Kubernetes <kubernetes>`
163163
- {ref}`Export a Flow to Kubernetes <kubernetes-export>`
164-
- {meth}`~jina-serve.Flow.to_kubernetes_yaml`
164+
- {meth}`~jina.Flow.to_kubernetes_yaml`
165165
- {ref}`Deploy a standalone Executor on Kubernetes <kubernetes-executor>`
166166
- [Kubernetes Documentation](https://kubernetes.io/docs/home/)

docs/concepts/client/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ with Flow(port=1234, protocol='grpc') as f:
6666
The Client has to specify the followings parameters to match the Flow and how it was set up:
6767
* the `protocol` it needs to use to communicate with the Flow
6868
* the `host` and the `port` as exposed by the Flow
69-
* if it needs to use `TLS` encryption (to connect to a {class}`~jina-serve.Flow` that has been {ref}`configured to use TLS <flow-tls>` in combination with gRPC, http, or websocket)
69+
* if it needs to use `TLS` encryption (to connect to a {class}`~jina.Flow` that has been {ref}`configured to use TLS <flow-tls>` in combination with gRPC, http, or websocket)
7070

7171

7272
````{Hint} Default port
@@ -186,7 +186,7 @@ c.post(
186186
(client-compress)=
187187
## Enable compression
188188

189-
If the communication to the Gateway is via gRPC, you can pass `compression` parameter to {meth}`~jina-serve.clients.mixin.PostMixin.post` to benefit from [gRPC compression](https://grpc.github.io/grpc/python/grpc.html#compression) methods.
189+
If the communication to the Gateway is via gRPC, you can pass `compression` parameter to {meth}`~jina.clients.mixin.PostMixin.post` to benefit from [gRPC compression](https://grpc.github.io/grpc/python/grpc.html#compression) methods.
190190

191191
The supported choices are: None, `gzip` and `deflate`.
192192

@@ -212,7 +212,7 @@ One can also specify the compression of the internal communication {ref}`as desc
212212

213213
## Simple profiling of the latency
214214

215-
Before sending any real data, you can test the connectivity and network latency by calling the {meth}`~jina-serve.clients.mixin.ProfileMixin.profiling` method:
215+
Before sending any real data, you can test the connectivity and network latency by calling the {meth}`~jina.clients.mixin.ProfileMixin.profiling` method:
216216

217217
```python
218218
from jina import Client

docs/concepts/client/send-receive-data.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ Hence, `deployment.post()` and `flow.post()` are not recommended outside of test
9898
(request-size-client)=
9999
## Send data in batches
100100

101-
Especially during indexing, a Client can send up to thousands or millions of Documents to a {class}`~jina-serve.Flow`.
101+
Especially during indexing, a Client can send up to thousands or millions of Documents to a {class}`~jina.Flow`.
102102
Those Documents are internally batched into a `Request`, providing a smaller memory footprint and faster response times
103103
thanks
104104
to {ref}`callback functions <callback-functions>`.
@@ -117,8 +117,8 @@ with Deployment() as dep:
117117

118118
## Send data asynchronously
119119

120-
There is an async version of the Python Client which works with {meth}`~jina-serve.clients.mixin.PostMixin.post` and
121-
{meth}`~jina-serve.clients.mixin.MutateMixin.mutate`.
120+
There is an async version of the Python Client which works with {meth}`~jina.clients.mixin.PostMixin.post` and
121+
{meth}`~jina.clients.mixin.MutateMixin.mutate`.
122122

123123
While the standard `Client` is also asynchronous under the hood, its async version exposes this fact to the outside
124124
world,
@@ -165,8 +165,8 @@ class DummyExecutor(Executor):
165165

166166
## Send data to specific Executors
167167

168-
Usually a {class}`~jina-serve.Flow` will send each request to all {class}`~jina-serve.Executor`s with matching endpoints as
169-
configured. But the {class}`~jina-serve.Client` also allows you to only target specific Executors in a Flow using
168+
Usually a {class}`~jina.Flow` will send each request to all {class}`~jina.Executor`s with matching endpoints as
169+
configured. But the {class}`~jina.Client` also allows you to only target specific Executors in a Flow using
170170
the `target_executor` keyword. The request will then only be processed by the Executors which match the provided
171171
target_executor regex. Its usage is shown in the listing below.
172172

@@ -209,7 +209,7 @@ Executor.
209209

210210
The Flow with **gRPC** protocol implements the unary and the streaming RPC lifecycle for communicating with the clients.
211211
When sending more than one request using the batching or the iterator mechanism, the RPC lifecycle for the
212-
{meth}`~jina-serve.clients.mixin.PostMixin.post` method can be controlled using the `stream` boolean method argument. By
212+
{meth}`~jina.clients.mixin.PostMixin.post` method can be controlled using the `stream` boolean method argument. By
213213
default the stream option is set to `True` which uses the streaming RPC to send the data to the Flow. If the stream
214214
option is set to `False`, the unary RPC is used to send the data to the Flow.
215215
Both RPC lifecycles are implemented to provide the flexibility for the clients.
@@ -247,7 +247,7 @@ used to overwrite the default options. The default **gRPC** options are:
247247
# allow grpc pings from client without data every 4 seconds
248248
```
249249

250-
If the `max_attempts` is greater than 1 on the {meth}`~jina-serve.clients.mixin.PostMixin.post` method,
250+
If the `max_attempts` is greater than 1 on the {meth}`~jina.clients.mixin.PostMixin.post` method,
251251
the `grpc.service_config` option will not be applied since the retry
252252
options will be configured internally.
253253

@@ -261,9 +261,9 @@ Refer to the {ref}`Configure Executor gRPC options <executor-grpc-server-options
261261

262262
## Returns
263263

264-
{meth}`~jina-serve.clients.mixin.PostMixin.post` returns a `DocList` containing all Documents flattened over all
264+
{meth}`~jina.clients.mixin.PostMixin.post` returns a `DocList` containing all Documents flattened over all
265265
Requests. When setting `return_responses=True`, this behavior is changed to returning a list of
266-
{class}`~jina-serve.types.request.data.Response` objects.
266+
{class}`~jina.types.request.data.Response` objects.
267267

268268
If a callback function is provided, `client.post()` will return none.
269269

@@ -331,7 +331,7 @@ None
331331

332332
### Return type
333333

334-
{meth}`~jina-serve.clients.mixin.PostMixin.post` returns the Documents as the server sends them back. In order for the client to
334+
{meth}`~jina.clients.mixin.PostMixin.post` returns the Documents as the server sends them back. In order for the client to
335335
return the user's expected document type, the `return_type` argument is required.
336336

337337
The `return_type` can be a parametrized `DocList` or a single `BaseDoc` type. If the return type parameter is a `BaseDoc` type,
@@ -355,7 +355,7 @@ requests may not be the same order as the Client sending them. Hence, the respon
355355
the sending order.
356356

357357
To force the order of the results to be deterministic and the same as when they are sent, passing `results_in_order`
358-
parameter to {meth}`~jina-serve.clients.mixin.PostMixin.post`.
358+
parameter to {meth}`~jina.clients.mixin.PostMixin.post`.
359359

360360
```python
361361
import random

docs/concepts/orchestration/add-executors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ f = Flow(extra_search_paths=['../executor']).add(uses='config1.yml').add(uses='c
5858

5959
(flow-configure-executors)=
6060
## Configure Executors
61-
You can set and override {class}`~jina-serve.Executor` configuration when adding them to an Orchestration.
61+
You can set and override {class}`~jina.Executor` configuration when adding them to an Orchestration.
6262

6363
This example shows how to start a Flow with an Executor using the Python API:
6464

docs/concepts/orchestration/deployment.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -166,14 +166,14 @@ dep.save_config('deployment.yml')
166166

167167
## Start and stop
168168

169-
When a {class}`~jina-serve.Deployment` starts, all the replicated Executors will start as well, making it possible to {ref}`reach the service through its API <third-party-client>`.
169+
When a {class}`~jina.Deployment` starts, all the replicated Executors will start as well, making it possible to {ref}`reach the service through its API <third-party-client>`.
170170

171171
There are three ways to start a Deployment: In Python, from a YAML file, or from the terminal.
172172

173173
- Generally in Python: use Deployment as a context manager.
174174
- As an entrypoint from terminal: use `Jina CLI <cli>` and a Deployment YAML file.
175175
- As an entrypoint from Python code: use Deployment as a context manager inside `if __name__ == '__main__'`
176-
- No context manager, manually call {meth}`~jina-serve.Deployment.start` and {meth}`~jina-serve.Deployment.close`.
176+
- No context manager, manually call {meth}`~jina.Deployment.start` and {meth}`~jina.Deployment.close`.
177177

178178
````{tab} General in Python
179179
```python

0 commit comments

Comments
 (0)