docs(doc/code-docs): support zh cn readthedocs (#289)

* feat(code-docs): test auto doc * feat(code-docs): test auto doc * feat(code-docs): test auto doc * feat(code-docs): test auto doc * docs(doc/code-docs): add zh_CN structure * docs(doc/code-docs): test install.md * docs(doc/code-docs): source file to zh * docs(doc/code-docs): update source files * docs(doc/code-docs): add locales en * docs(doc/code-docs): add locales en install * docs(doc/code-docs): add locales en example * docs(doc/code-docs): update en checkpoint * add en translation for parallel.rst docs * add en translation for profiler.po docs * docs(doc/code-docs): update en monitor * add en translation for monuitor, qa, training docs * add en translation for quickstart docs * docs(doc/code-docs): update monitor.po and usage.po * docs(doc/code-docs): fix typos * docs(doc/code-docs): update en parallel * docs(doc/code-docs): update en parallel * docs(doc/code-docs): update en usage * docs(doc/code-docs): update en profilier * docs(doc/code-docs): update en initialize * docs(doc/code-docs): update en initialize * docs(doc/code-docs): update en initialize * docs(doc/code-docs): update en initialize --------- Co-authored-by: zigzagcai <caizheng@pjlab.org.cn>
InternLM · Sep 7, 2023 · 671c752 · 671c752
1 parent b6d909d
commit 671c752
Show file tree

Hide file tree

Showing 30 changed files with 2,141 additions and 141 deletions.
diff --git a/doc/code-docs/locales/en/LC_MESSAGES/checkpoint.po b/doc/code-docs/locales/en/LC_MESSAGES/checkpoint.po
@@ -0,0 +1,123 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) 2023, InternLM Team
+# This file is distributed under the same license as the InternLM package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2023.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: InternLM \n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2023-09-07 10:56+0800\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language: en\n"
+"Language-Team: en <LL@li.org>\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.12.1\n"
+
+#: ../../source/checkpoint.rst:2 09c8645fba264cdf9a80c4b62c2bb4d1
+msgid "模型保存"
+msgstr "Model Checkpointing"
+
+#: ../../source/checkpoint.rst:4 8b158d34631045b1afdb4fb0169b3c71
+msgid ""
+"InternLM 使用 ``internlm.utils.model_checkpoint.CheckpointManager`` "
+"来管理模型保存。 其中，可以 使用 ``CheckpointManager.try_save_checkpoint(train_state)`` "
+"来保存指定 step 的模型状态。InternLM支持启动时自动加载最新的模型备份，并在接收信号退出训练时自动进行模型备份。"
+msgstr ""
+"InternLM uses ``internlm.utils.model_checkpoint.CheckpointManager`` to manage model checkpointing. In the implementation, "
+"we use ``CheckpointManager.try_save_checkpoint(train_state)`` to checkpoint training states at specific steps. InternLM supports "
+"automatic loading of latest ckpt at startup and automatic model checkpointing at signal quit."
+
+#: ../../source/checkpoint.rst:8 a023b5a6d15749bfaa51cf2da194bda1
+msgid "Checkpointing"
+msgstr ""
+
+#: 938575c699d1426c87e0b3f589a85d50
+#: internlm.utils.model_checkpoint.CheckpointManager:1 of
+msgid "StorageManagerContext"
+msgstr ""
+
+#: 754d6881cd034c5ebaab0f3362dd14c2
+#: internlm.utils.model_checkpoint.CheckpointManager.quit_signal_handler:1 of
+msgid ""
+"Exit signal detection function, if we write the exit step in the "
+"'QUIT_FILE_PATH' file, all ranks will save ckpt and exit. Negative "
+"integer step means save ckpt. Positive integer step means save ckpt and "
+"quit."
+msgstr ""
+
+#: 2169f9fb4a8b40bc9bf6093894fc7a5e 6a55d2b2b24a44c8b78b40f19f4d950b
+#: internlm.utils.model_checkpoint.CheckpointManager.quit_signal_handler
+#: internlm.utils.model_checkpoint.CheckpointManager.try_resume_training of
+msgid "参数"
+msgstr ""
+
+#: 360a89b1591e4627ac432f4d75050354
+#: internlm.utils.model_checkpoint.CheckpointManager.quit_signal_handler of
+msgid "返回"
+msgstr ""
+
+#: 2426832f4a8a4c5481be1c940e0e7b50
+#: internlm.utils.model_checkpoint.CheckpointManager.quit_signal_handler:9 of
+msgid "whether to quit."
+msgstr ""
+
+#: 5f6842c261544a3c89f32d981b3ad755
+#: internlm.utils.model_checkpoint.CheckpointManager.quit_signal_handler of
+msgid "返回类型"
+msgstr ""
+
+#: 1392da84b6e645bcb8dab605e1231fdc
+#: internlm.utils.model_checkpoint.CheckpointManager.wait_async_upload_finish:1
+#: of
+msgid "wait for all checkpoint uploads to be completed"
+msgstr ""
+
+#: d1774593e9c94608b49b10504bfbc38b
+#: internlm.utils.model_checkpoint.CheckpointManager.query_latest_snapshot_step_boto3:1
+#: of
+msgid ""
+"Returns: Tuple(str, int): path of latest ckpt and ckpt step, if not "
+"found, None will return."
+msgstr ""
+
+#: a3abbbd2bd574872892d908ab248e804
+#: internlm.utils.model_checkpoint.CheckpointManager.try_resume_training:1 of
+msgid "Attempt to restore the training state of the last ckpt."
+msgstr ""
+
+#: de021d1eb6d54955a2850c11c0191710
+#: internlm.utils.model_checkpoint.CheckpointManager.try_resume_training:3 of
+msgid "lr_scheduler object."
+msgstr ""
+
+#: 20be15854f2e420a9d96c86b5869bfa6
+#: internlm.utils.model_checkpoint.CheckpointManager.try_resume_training:5 of
+msgid "optimizer object."
+msgstr ""
+
+#: 68f69086c5054acc8aca15c8a764acc5
+#: internlm.utils.model_checkpoint.CheckpointManager.try_resume_training:7 of
+msgid "learning rate."
+msgstr ""
+
+#: 5d34d34a972d4abeab4bda3e49ee157b
+#: internlm.utils.model_checkpoint.CheckpointManager.try_resume_training:9 of
+msgid "traing states."
+msgstr ""
+
+#: 82ebb67afaa748ecabc4cef598d7fc30
+#: internlm.utils.model_checkpoint.CheckpointManager.try_resume_training:11 of
+msgid "traning dataloader object"
+msgstr ""
+
+#: 0c95dfcd712749279daca78166bb4326
+#: internlm.utils.model_checkpoint.CheckpointManager.save_checkpoint:1 of
+msgid "Save checkpoint to the given folder path."
+msgstr ""
+
diff --git a/doc/code-docs/locales/en/LC_MESSAGES/example/30B_demo.po b/doc/code-docs/locales/en/LC_MESSAGES/example/30B_demo.po
@@ -0,0 +1,50 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) 2023, InternLM Team
+# This file is distributed under the same license as the InternLM package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2023.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: InternLM \n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2023-09-07 10:56+0800\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language: en\n"
+"Language-Team: en <LL@li.org>\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.12.1\n"
+
+#: ../../source/example/30B_demo.rst:2 242d1f89ae2045f1bf1f31bf82f07846
+msgid "30B Demo"
+msgstr ""
+
+#: ../../source/example/30B_demo.rst:5 c2415bfa6978414a939dcc395fdfb544
+msgid "训练配置"
+msgstr "Training Config"
+
+#: ../../source/example/30B_demo.rst:7 75f568d1ca5546228f88958c12c2dd65
+msgid "30B demo 训练配置文件样例如下:"
+msgstr "30B demo config file example:"
+
+#: ../../source/example/30B_demo.rst:164 533cb04f94314eeb8381e45f06d03108
+msgid "启动训练"
+msgstr "Start Training"
+
+#: ../../source/example/30B_demo.rst:166 24974384d5ab42e68266aeb67ae222ce
+msgid "完成以上训练配置后，可启动模型训练，以在 ``slurm`` 平台上为例，启动两节点 16GPU 的训练命令如下所示："
+msgstr "After completing the data preparation and relevant training configurations, you can start the demo training.
+The following example shows how to start distributed training in ``slurm`` environments with 16 GPUs."
+
+#: ../../source/example/30B_demo.rst:173 948ac71ed53848f9bad07f69d956c4bb
+msgid "训练结果"
+msgstr "Training Results"
+
+#: ../../source/example/30B_demo.rst:175 615a3481b0aa49729b7219b1365519aa
+msgid "基于以上训练配置和启动命令，两节点 16GPU 下的模型训练部分日志展示如下："
+msgstr "Taking the configuration of the demo training on two nodes with 16 GPUs on slurm as an example, the training result log is shown below:"
+
diff --git a/doc/code-docs/locales/en/LC_MESSAGES/example/7B_demo.po b/doc/code-docs/locales/en/LC_MESSAGES/example/7B_demo.po
@@ -0,0 +1,50 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) 2023, InternLM Team
+# This file is distributed under the same license as the InternLM package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2023.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: InternLM \n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2023-09-07 10:56+0800\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language: en\n"
+"Language-Team: en <LL@li.org>\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.12.1\n"
+
+#: ../../source/example/7B_demo.rst:2 8576f969040249bb93e7c347ef210990
+msgid "7B Demo"
+msgstr ""
+
+#: ../../source/example/7B_demo.rst:5 5429ceea12424825991744bece744f60
+msgid "训练配置"
+msgstr "Training Config"
+
+#: ../../source/example/7B_demo.rst:7 c9a47faf5deb40b68ad2bc950fdf2b14
+msgid "7B demo 的训练配置文件样例如下:"
+msgstr "7B demo config file example:"
+
+#: ../../source/example/7B_demo.rst:162 eb93a6ca05c8421eb87a2470f9f31fc2
+msgid "启动训练"
+msgstr "Start Training"
+
+#: ../../source/example/7B_demo.rst:164 9e7a864ae2e14d05b0681f16792e5278
+msgid "完成以上训练配置后，可启动模型训练，以在 ``slurm`` 平台上为例，启动单节点 8GPU 的训练命令如下所示："
+msgstr "After completing the data preparation and relevant training configurations, you can start the demo training.
+The following example shows how to start distributed training in ``slurm`` environments with 8 GPUs."
+
+#: ../../source/example/7B_demo.rst:171 fdd053efb1854d46aabf6c0f279fe7fc
+msgid "训练结果"
+msgstr "Training Results"
+
+#: ../../source/example/7B_demo.rst:173 33ec81f34e3c4340beacdb5254069d08
+msgid "基于以上训练配置和启动命令，单节点 8GPU 下的模型训练部分日志展示如下："
+msgstr "Taking the configuration of the demo training on a single machine with 8 GPUs on slurm as an example, the training result log is shown below:"
+
diff --git a/doc/code-docs/locales/en/LC_MESSAGES/example/index.po b/doc/code-docs/locales/en/LC_MESSAGES/example/index.po
@@ -0,0 +1,33 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) 2023, InternLM Team
+# This file is distributed under the same license as the InternLM package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2023.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: InternLM \n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2023-09-07 10:56+0800\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language: en\n"
+"Language-Team: en <LL@li.org>\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.12.1\n"
+
+#: ../../source/example/index.rst:2 de54695e8bde40ffb8878043072197e6
+msgid "训练样例"
+msgstr "Training Example"
+
+#: ../../source/example/index.rst:5 da388b3209ff4bd39fd0700a7fba413a
+msgid "7B Demo"
+msgstr ""
+
+#: ../../source/example/index.rst:13 b095e27dfc924a7a943b7cba5361700a
+msgid "30B Demo"
+msgstr ""
+
diff --git a/doc/code-docs/locales/en/LC_MESSAGES/index.po b/doc/code-docs/locales/en/LC_MESSAGES/index.po
@@ -0,0 +1,81 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) 2023, InternLM Team
+# This file is distributed under the same license as the InternLM package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2023.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: InternLM \n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2023-09-07 10:56+0800\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language: en\n"
+"Language-Team: en <LL@li.org>\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.12.1\n"
+
+#: ../../source/index.rst:8 11e029810acf410180311a3c63eb01f4
+msgid "InternLM"
+msgstr "InternLM"
+
+#: ../../source/index.rst:11 e6fd7d058e4b43bb81157ac79867e3d3
+msgid "环境构建"
+msgstr "Environment Setup"
+
+#: ../../source/index.rst:19 f323ede90c0f434d8b627eded1d8fc10
+msgid "快速上手"
+msgstr "Quickstart Guide"
+
+#: ../../source/index.rst:27 3c504b4b92264e9182abb0fa81fe80c3
+msgid "训练构建"
+msgstr "Model Setup"
+
+#: ../../source/index.rst:35 5cc5c831399a40b089d27b777a776b16
+msgid "训练 API"
+msgstr "Training API"
+
+#: ../../source/index.rst:43 21a7473eabb441f8bfe28d2a0e306889
+msgid "并行训练"
+msgstr "Parallel Training"
+
+#: ../../source/index.rst:51 9234725f3c464731993d73607608c874
+msgid "模型备份"
+msgstr "Model Checkpointing"
+
+#: ../../source/index.rst:59 8e4ce037017f4510b2892a66003877fa
+msgid "性能分析"
+msgstr "Profiler"
+
+#: ../../source/index.rst:67 a36e02819ecd4b448a8cb4ebbecb6600
+msgid "训练监控"
+msgstr "Monitor"
+
+#: ../../source/index.rst:75 b912e292486f455c8b5cdd75962e8ac2
+msgid "训练样例"
+msgstr "Example"
+
+#: ../../source/index.rst:83 ea9e9281720941a1830e5df7a2badf7a
+msgid "常见问题"
+msgstr "Q&A"
+
+#: ../../source/index.rst:91 e08edc5aa1c74965b10084b393b88fae
+msgid "索引和表格"
+msgstr "Indices and tables"
+
+#: ../../source/index.rst:93 f3fdca059caa49dcad09aa44be7f02d6
+msgid ":ref:`genindex`"
+msgstr ""
+
+#: ../../source/index.rst:94 b3791e811315435097bb507edc3f4b9b
+msgid ":ref:`modindex`"
+msgstr ""
+
+#: ../../source/index.rst:95 a164b772960f4ab8b18c7e8820f69f55
+msgid ":ref:`search`"
+msgstr ""
+