Skip to content

Commit 78bb78b

Browse files
qianduoduo0904qianduoduo0904
authored
DOC: Add i18n support (xorbitsai#161)
1 parent 568aaee commit 78bb78b

37 files changed

+13446
-1
lines changed

‎doc/source/conf.py‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
# -- Project information -----------------------------------------------------
77
project = "Xorbits"
8-
copyright = "2022, Xprobe-inc"
8+
copyright = "2022-2023, Xprobe Inc."
99
author = "Xprobe-inc"
1010

1111
from xorbits import __version__
@@ -29,6 +29,10 @@
2929
templates_path = ["_templates"]
3030
exclude_patterns = []
3131

32+
# i18n
33+
locale_dirs = ['locale/'] # path is example but recommended.
34+
gettext_compact = False # optional
35+
3236

3337
# -- Options for HTML output -------------------------------------------------
3438
html_theme = "pydata_sphinx_theme"

‎doc/source/locale/zh_CN/LC_MESSAGES/deployment/cloud.po‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
# SOME DESCRIPTIVE TITLE.
2+
# Copyright (C) 2022-2023, Xprobe Inc.
3+
# This file is distributed under the same license as the Xorbits package.
4+
# FIRST AUTHOR <EMAIL@ADDRESS>, 2023.
5+
#
6+
#, fuzzy
7+
msgid ""
8+
msgstr ""
9+
"Project-Id-Version: Xorbits \n"
10+
"Report-Msgid-Bugs-To: \n"
11+
"POT-Creation-Date: 2023-01-12 11:23+0800\n"
12+
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13+
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
14+
"Language-Team: LANGUAGE <[email protected]>\n"
15+
"MIME-Version: 1.0\n"
16+
"Content-Type: text/plain; charset=utf-8\n"
17+
"Content-Transfer-Encoding: 8bit\n"
18+
"Generated-By: Babel 2.11.0\n"
19+
20+
#: ../../source/deployment/cloud.rst:5
21+
msgid "Cloud deployment"
22+
msgstr ""
23+
24+
#: ../../source/deployment/cloud.rst:8
25+
msgid "Prerequisites"
26+
msgstr ""
27+
28+
#: ../../source/deployment/cloud.rst:9
29+
msgid "Currently, we support deploying Xorbits on an existing Amazon EKS cluster."
30+
msgstr ""
31+
32+
#: ../../source/deployment/cloud.rst:11
33+
msgid ""
34+
"Install Xorbits on the machine for Amazon EKS cluster management. Refer "
35+
"to :ref:`installation document <installation>`."
36+
msgstr ""
37+
38+
#: ../../source/deployment/cloud.rst:15
39+
msgid "Amazon EKS"
40+
msgstr ""
41+
42+
#: ../../source/deployment/cloud.rst:16
43+
msgid ""
44+
"Firstly, make sure your EKS cluster can access `our Dockerhub "
45+
"<https://hub.docker.com/repository/docker/xprobe/xorbits>`_ to pull the "
46+
"Xorbits image."
47+
msgstr ""
48+
49+
#: ../../source/deployment/cloud.rst:18
50+
msgid ""
51+
"Secondly, install the `AWS Load Balancer Controller "
52+
"<https://docs.aws.amazon.com/eks/latest/userguide/aws-load-balancer-"
53+
"controller.html>`_."
54+
msgstr ""
55+
56+
#: ../../source/deployment/cloud.rst:20
57+
msgid "Then, deploy Xorbits cluster, for example:"
58+
msgstr ""
59+
60+
#: ../../source/deployment/cloud.rst:29
61+
msgid ""
62+
"Note that the option ``cluster_type`` of the function ``new_cluster`` has"
63+
" default value ``auto``, which means that Xorbits will detect the "
64+
"``kubectl`` context automatically. Please make sure ``kubectl`` is using "
65+
"the correct EKS context."
66+
msgstr ""
67+
68+
#: ../../source/deployment/cloud.rst:32
69+
msgid ""
70+
"You should be able to see ``Xorbits endpoint "
71+
"http://<ingress_service_ip>:80 is ready!`` soon, and you can access the "
72+
"web UI of your Xorbits cluster using the endpoint."
73+
msgstr ""
74+
75+
#: ../../source/deployment/cloud.rst:35
76+
msgid ""
77+
"Refer :ref:`Kubernetes deployment <deployment_image>` to deploy Xorbits "
78+
"with your own image."
79+
msgstr ""
80+
81+
#: ../../source/deployment/cloud.rst:37
82+
msgid ""
83+
"``new_cluster`` api refers to "
84+
":meth:`xorbits.deploy.kubernetes.client.new_cluster`."
85+
msgstr ""
86+
87+
#: ../../source/deployment/cloud.rst:39
88+
msgid "To verify the cluster:"
89+
msgstr ""
90+

‎doc/source/locale/zh_CN/LC_MESSAGES/deployment/cluster.po‎

Lines changed: 269 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,269 @@
1+
# SOME DESCRIPTIVE TITLE.
2+
# Copyright (C) 2022-2023, Xprobe Inc.
3+
# This file is distributed under the same license as the Xorbits package.
4+
# FIRST AUTHOR <EMAIL@ADDRESS>, 2023.
5+
#
6+
#, fuzzy
7+
msgid ""
8+
msgstr ""
9+
"Project-Id-Version: Xorbits \n"
10+
"Report-Msgid-Bugs-To: \n"
11+
"POT-Creation-Date: 2023-01-12 11:23+0800\n"
12+
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13+
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
14+
"Language-Team: LANGUAGE <[email protected]>\n"
15+
"MIME-Version: 1.0\n"
16+
"Content-Type: text/plain; charset=utf-8\n"
17+
"Content-Transfer-Encoding: 8bit\n"
18+
"Generated-By: Babel 2.11.0\n"
19+
20+
#: ../../source/deployment/cluster.rst:5
21+
msgid "Cluster deployment"
22+
msgstr ""
23+
24+
#: ../../source/deployment/cluster.rst:7
25+
msgid ""
26+
"If you have some machines either on the cloud or not, and you want to "
27+
"deploy Xorbits via command lines, you can refer to this documentation."
28+
msgstr ""
29+
30+
#: ../../source/deployment/cluster.rst:11
31+
msgid "Installation"
32+
msgstr ""
33+
34+
#: ../../source/deployment/cluster.rst:13
35+
msgid ""
36+
"First, ensure Xorbits is correctly installed on each machine, if not, see"
37+
" :ref:`installation document <installation>`."
38+
msgstr ""
39+
40+
#: ../../source/deployment/cluster.rst:16
41+
msgid "Starting Supervisor"
42+
msgstr ""
43+
44+
#: ../../source/deployment/cluster.rst:18
45+
msgid ""
46+
"Among the machines, pick at least one as the supervisor which ships with "
47+
"a web service as well, starting supervisor via command:"
48+
msgstr ""
49+
50+
#: ../../source/deployment/cluster.rst:25
51+
#: ../../source/deployment/cluster.rst:46
52+
msgid "Or using ``python -m``:"
53+
msgstr ""
54+
55+
#: ../../source/deployment/cluster.rst:31
56+
msgid "`<web_port>` is used for creating a web service, which is used for:"
57+
msgstr ""
58+
59+
#: ../../source/deployment/cluster.rst:33
60+
msgid ""
61+
"Provide a web UI to show cluster status and detailed information of "
62+
"submitted tasks."
63+
msgstr ""
64+
65+
#: ../../source/deployment/cluster.rst:34
66+
msgid ""
67+
"Accept connections from clients when users call "
68+
"`xorbits.init(\"<supervisor_ip>:<web_port>\")` to connect to a cluster."
69+
msgstr ""
70+
71+
#: ../../source/deployment/cluster.rst:38
72+
msgid "Starting Workers"
73+
msgstr ""
74+
75+
#: ../../source/deployment/cluster.rst:40
76+
msgid "The rest of the machines can be started as workers via command:"
77+
msgstr ""
78+
79+
#: ../../source/deployment/cluster.rst:53
80+
msgid "Connecting to Created Cluster"
81+
msgstr ""
82+
83+
#: ../../source/deployment/cluster.rst:55
84+
msgid ""
85+
"Now, you can connect to the supervisor from anywhere that can run Python "
86+
"code."
87+
msgstr ""
88+
89+
#: ../../source/deployment/cluster.rst:63
90+
msgid ""
91+
"Replace the ``<supervisor_ip>`` with the supervisor IP that you just "
92+
"specified and ``<supervisor_web_port>`` with the supervisor web port."
93+
msgstr ""
94+
95+
#: ../../source/deployment/cluster.rst:67
96+
msgid "Xorbits Web UI"
97+
msgstr ""
98+
99+
#: ../../source/deployment/cluster.rst:69
100+
msgid ""
101+
"You can open a web browser and type "
102+
"``http://<supervisor_ip>:<supervisor_web_port>`` to open Xorbits Web UI "
103+
"to look up resource usage of workers and execution progress of submitted "
104+
"tasks."
105+
msgstr ""
106+
107+
#: ../../source/deployment/cluster.rst:73
108+
msgid "Command Line Options"
109+
msgstr ""
110+
111+
#: ../../source/deployment/cluster.rst:76
112+
msgid "Common Options"
113+
msgstr ""
114+
115+
#: ../../source/deployment/cluster.rst:78
116+
msgid "Common Command line options are listed below."
117+
msgstr ""
118+
119+
#: ../../source/deployment/cluster.rst:81
120+
#: ../../source/deployment/cluster.rst:107
121+
#: ../../source/deployment/cluster.rst:116
122+
msgid "Argument"
123+
msgstr ""
124+
125+
#: ../../source/deployment/cluster.rst:81
126+
#: ../../source/deployment/cluster.rst:107
127+
#: ../../source/deployment/cluster.rst:116
128+
msgid "Description"
129+
msgstr ""
130+
131+
#: ../../source/deployment/cluster.rst:83
132+
msgid "``-H``"
133+
msgstr ""
134+
135+
#: ../../source/deployment/cluster.rst:83
136+
msgid "Service IP binding, ``0.0.0.0`` by default"
137+
msgstr ""
138+
139+
#: ../../source/deployment/cluster.rst:85
140+
msgid "``-p``"
141+
msgstr ""
142+
143+
#: ../../source/deployment/cluster.rst:85
144+
msgid "Port of the service. If absent, a randomized port will be used"
145+
msgstr ""
146+
147+
#: ../../source/deployment/cluster.rst:87
148+
msgid "``-f``"
149+
msgstr ""
150+
151+
#: ../../source/deployment/cluster.rst:87
152+
msgid "Path to service configuration file. Absent when use default configuration."
153+
msgstr ""
154+
155+
#: ../../source/deployment/cluster.rst:90
156+
msgid "``-s``"
157+
msgstr ""
158+
159+
#: ../../source/deployment/cluster.rst:90
160+
msgid ""
161+
"List of supervisor endpoints, separated by commas. Useful for workers to "
162+
"spot supervisors, or when you want to run more than one supervisor"
163+
msgstr ""
164+
165+
#: ../../source/deployment/cluster.rst:94
166+
msgid "``--log-level``"
167+
msgstr ""
168+
169+
#: ../../source/deployment/cluster.rst:94
170+
msgid "Log level, can be ``debug``, ``info``, ``warning``, ``error``"
171+
msgstr ""
172+
173+
#: ../../source/deployment/cluster.rst:96
174+
msgid "``--log-format``"
175+
msgstr ""
176+
177+
#: ../../source/deployment/cluster.rst:96
178+
msgid "Log format, can be Python logging format"
179+
msgstr ""
180+
181+
#: ../../source/deployment/cluster.rst:98
182+
msgid "``--log-conf``"
183+
msgstr ""
184+
185+
#: ../../source/deployment/cluster.rst:98
186+
msgid "Python logging configuration file, ``logging.conf`` by default"
187+
msgstr ""
188+
189+
#: ../../source/deployment/cluster.rst:100
190+
msgid "``--use-uvloop``"
191+
msgstr ""
192+
193+
#: ../../source/deployment/cluster.rst:100
194+
msgid "Whether to use ``uvloop`` to accelerate, ``auto`` by default"
195+
msgstr ""
196+
197+
#: ../../source/deployment/cluster.rst:104
198+
msgid "Extra Options for Supervisors"
199+
msgstr ""
200+
201+
#: ../../source/deployment/cluster.rst:109
202+
msgid "``-w``"
203+
msgstr ""
204+
205+
#: ../../source/deployment/cluster.rst:109
206+
msgid "Port of web service in supervisor"
207+
msgstr ""
208+
209+
#: ../../source/deployment/cluster.rst:113
210+
msgid "Extra Options for Workers"
211+
msgstr ""
212+
213+
#: ../../source/deployment/cluster.rst:118
214+
msgid "``--n-cpu``"
215+
msgstr ""
216+
217+
#: ../../source/deployment/cluster.rst:118
218+
msgid ""
219+
"Number of CPU cores to use. If absent, the value will be the available "
220+
"number of cores"
221+
msgstr ""
222+
223+
#: ../../source/deployment/cluster.rst:121
224+
msgid "``--n-io-process``"
225+
msgstr ""
226+
227+
#: ../../source/deployment/cluster.rst:121
228+
msgid "Number of IO processes for network operations. 1 by default"
229+
msgstr ""
230+
231+
#: ../../source/deployment/cluster.rst:123
232+
msgid "``--cuda-devices``"
233+
msgstr ""
234+
235+
#: ../../source/deployment/cluster.rst:123
236+
msgid ""
237+
"Index of CUDA devices to use. If not specified, all devices will be used."
238+
" Specifying an empty string will ignore all devices"
239+
msgstr ""
240+
241+
#: ../../source/deployment/cluster.rst:129
242+
msgid "Example"
243+
msgstr ""
244+
245+
#: ../../source/deployment/cluster.rst:131
246+
msgid ""
247+
"For instance, if you want to start a Xorbits cluster with one supervisor "
248+
"and two workers, you can run commands below (memory and CPU tunings are "
249+
"omitted):"
250+
msgstr ""
251+
252+
#: ../../source/deployment/cluster.rst:134
253+
msgid "On Supervisor (192.168.1.10):"
254+
msgstr ""
255+
256+
#: ../../source/deployment/cluster.rst:140
257+
msgid "On Worker 1 (192.168.1.20):"
258+
msgstr ""
259+
260+
#: ../../source/deployment/cluster.rst:146
261+
msgid "On Worker 2 (192.168.1.21):"
262+
msgstr ""
263+
264+
#: ../../source/deployment/cluster.rst:152
265+
msgid ""
266+
"On a client which is able to connect to supervisor, you can run the "
267+
"Python code below to verify:"
268+
msgstr ""
269+

0 commit comments

Comments
 (0)