docs: update LLM Chat Test and LLM Playground features (#83)

* docs: update LLM chat test features * docs: LLM playground * docs: apply feedbacks * docs: fix title underline warning
lablup · Sep 23, 2024 · c5c5ed5 · c5c5ed5
1 parent 2f13de8
commit c5c5ed5
Show file tree

Hide file tree

Showing 17 changed files with 438 additions and 60 deletions.
diff --git a/docs/LLM_playground/LLM_playground.png b/docs/LLM_playground/LLM_playground.png
diff --git a/docs/LLM_playground/LLM_playground.rst b/docs/LLM_playground/LLM_playground.rst
@@ -0,0 +1,80 @@
+.. _LLM-playground:
+
+==============
+LLM Playground
+==============
+
+LLM Playground
+--------------
+
+Starting from version 24.03, Backend.AI introduces the 'LLM Playground' feature, 
+which enables users to conveniently compare and interact with different LLM models all in one location.
+This allows users to experience the services offered by Backend.AI as well as a variety of large language models (LLMs).
+
+
+.. image:: LLM_playground.png
+    :align: center
+    :alt: LLM Playground
+
+Selecting models
+----------------
+
+Each card's top left corner features an endpoint selector and a model selector. The endpoint selector 
+enables the search and selection of endpoints established by Backend.AI services. The model selector allows for the choice of a model ID; 
+If the model is unavailable, it defaults to 'Custom'.
+
+.. image:: custom_model.png
+    :align: center
+    :alt: Selecting models
+
+Refer to the description below for the necessary inputs to configure custom modal settings:
+
+- baseURL: Base URL of the server where the model is located. 
+  Make sure to include the version information. 
+  For instance, when utilizing the OpenAI API, you should enter https://api.openai.com/v1.
+- Model ID: Unique identifier of the model. To specify the model you wish to use, you would provide its unique identifier. 
+  For instance, for GPT-4, you would input 'gpt-4o'. 
+- Token (optional): An authentication key to access the model service. Tokens can be 
+  generated from various services, not just Backend.AI. The format and generation process
+  may vary depending on the service. Always refer to the specific service's guide for details.
+  For instance, when using the service generated by Backend.AI, please refer to the
+  :ref:`Generating Tokens<generating-tokens>` section for instructions on how to generate tokens.
+
+Add or remove chat cards
+------------------------
+
+To add new chat cards, click the '+' icon located in the top right corner. 
+
+.. image:: add_cards.png
+    :align: center
+    :alt: Add chat cards
+
+To remove a chat session, click on the 'x' icon located in the upper right corner of the chat card. 
+Please be cautious as this will delete all entered content.
+
+.. image:: delete_chatting_session.png
+    :align: center
+    :alt: Remove chatting cards
+
+Delete chat history
+-------------------
+
+Clicking the 'More' button will reveal the 'Delete Chat History' option. 
+By selecting this, you will erase all chat history associated with the card, 
+although the card session itself will remain active. 
+
+.. image:: delete_chat_history.png
+    :align: center
+    :alt: Delete chat history
+
+Synchronize input
+-----------------
+
+The 'Sync Input' button located at the top right enables the synchronization of input across all chat cards. 
+Enabling 'Sync input' means that pressing 'Enter' or clicking the 'Send' button on 
+any card will submit the input from the card you are currently working on. 
+This functionality is beneficial for comparing the outputs of various models using identical input data.
+
+.. image:: synchronized_input.png
+    :align: center
+    :alt: Synchronize input
diff --git a/docs/LLM_playground/add_cards.png b/docs/LLM_playground/add_cards.png
diff --git a/docs/LLM_playground/custom_model.png b/docs/LLM_playground/custom_model.png
diff --git a/docs/LLM_playground/delete_chat_history.png b/docs/LLM_playground/delete_chat_history.png
diff --git a/docs/LLM_playground/delete_chatting_session.png b/docs/LLM_playground/delete_chatting_session.png
diff --git a/docs/LLM_playground/synchronized_input.png b/docs/LLM_playground/synchronized_input.png
diff --git a/docs/index.rst b/docs/index.rst
@@ -28,6 +28,7 @@ The latest versions of this document can be found from sites below:
    summary/summary
    sessions_all/sessions_all
    model_serving/model_serving
+   LLM_playground/LLM_playground
    import_run/import_run
    vfolder/vfolder
    mount_vfolder/mount_vfolder

diff --git a/docs/locale/ko/LC_MESSAGES/LLM_playground/LLM_playground.po b/docs/locale/ko/LC_MESSAGES/LLM_playground/LLM_playground.po
@@ -0,0 +1,147 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) 2024, Lablup Inc.
+# This file is distributed under the same license as the Backend.AI WebUI
+# User Guide package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2024.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Backend.AI Web-UI User Guide 24.03\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2024-09-24 00:03+0900\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language: ko\n"
+"Language-Team: ko <[email protected]>\n"
+"Plural-Forms: nplurals=1; plural=0;\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.14.0\n"
+
+#: ../../LLM_playground/LLM_playground.rst:-1
+#: ../../LLM_playground/LLM_playground.rst:5
+#: ../../LLM_playground/LLM_playground.rst:8
+msgid "LLM Playground"
+msgstr ""
+
+#: ../../LLM_playground/LLM_playground.rst:10
+msgid ""
+"Starting from version 24.03, Backend.AI introduces the 'LLM Playground' "
+"feature, which enables users to conveniently compare and interact with "
+"different LLM models all in one location. This allows users to experience"
+" the services offered by Backend.AI as well as a variety of large "
+"language models (LLMs)."
+msgstr ""
+"Backend.AI 24.03 버전부터 'LLM Playground' 기능을 통해 다양한 LLM 모델을 한 눈에 비교하고, 사용할 수 있습니다. " 
+"LLM Playground를 통해 사용자는 Backend.AI가 제공하는 서비스뿐만 아니라 여러 LLM 모델을 직접 체험해 볼 수 있습니다." 
+
+#: ../../LLM_playground/LLM_playground.rst:-1
+#: ../../LLM_playground/LLM_playground.rst:20
+msgid "Selecting models"
+msgstr "모델 선택하기"
+
+#: ../../LLM_playground/LLM_playground.rst:22
+msgid ""
+"Each card's top left corner features an endpoint selector and a model "
+"selector. The endpoint selector enables the search and selection of "
+"endpoints established by Backend.AI services. The model selector allows "
+"for the choice of a model ID; If the model is unavailable, it defaults to"
+" 'Custom'."
+msgstr ""
+"LLM Playground 내부 카드 왼쪽 상단에는 엔드포인트 선택기와 모델 선택기가 있습니다. 엔드포인트 선택기를 통해 Backend.AI에서 생성한 서비스의 엔드포인트들을 "
+"검색하고 선택할 수 있습니다. 모델 선택기에서는 모델 ID를 선택할 수 있으며, 모델을 불러올 수 없는 경우에는 'Custom'으로 설정됩니다."  
+
+#: ../../LLM_playground/LLM_playground.rst:30
+msgid ""
+"Refer to the description below for the necessary inputs to configure "
+"custom modal settings:"
+msgstr "사용자 정의 모델 설정에 필요한 입력 사항은 다음 설명을 참조하십시오."
+
+#: ../../LLM_playground/LLM_playground.rst:32
+msgid ""
+"baseURL: Base URL of the server where the model is located. Make sure to "
+"include the version information. For instance, when utilizing the OpenAI "
+"API, you should enter https://api.openai.com/v1."
+msgstr ""
+"baseURL: 모델이 위치한 서버의 기본 URL. 해당 URL에는 버전 정보가 포함되어 있어야 합니다. 예를 들어, OpenAI API를"
+" 사용하는 경우, https://api.openai.com/v1 을 입력해야 합니다."  
+
+#: ../../LLM_playground/LLM_playground.rst:35
+msgid ""
+"Model ID: Unique identifier of the model. To specify the model you wish "
+"to use, you would provide its unique identifier. For instance, for GPT-4,"
+" you would input 'gpt-4o'."
+msgstr "Model ID: 사용하려는 모델의 고유 식별자. 모델을 지정하려면 고유 식별자를 제공해야 합니다. 예를 들어, GPT-4의 경우 gpt-4o를 입력합니다."
+
+#: ../../LLM_playground/LLM_playground.rst:37
+msgid ""
+"Token (optional): An authentication key to access the model service. "
+"Tokens can be generated from various services, not just Backend.AI. The "
+"format and generation process may vary depending on the service. Always "
+"refer to the specific service's guide for details. For instance, when "
+"using the service generated by Backend.AI, please refer to the "
+":ref:`Generating Tokens<generating-tokens>` section for instructions on "
+"how to generate tokens."
+msgstr ""
+"Token (선택사항): 모델 서비스에 접근하기 위한 인증 키. 토큰은 Backend.AI 뿐만 아니라 다양한 서비스에서 생성할 수"
+" 있습니다. 토큰 생성 방법은 서비스에 따라 다를 수 있습니다. 자세한 내용은 해당 서비스의 안내를 참조하십시오. " 
+"Backend.AI에서 생성한 서비스를 사용하는 경우, 토큰 생성 방법은 :ref:`토큰 발급하기<generating-"
+"tokens>` 섹션을 참조하십시오."
+
+#: ../../LLM_playground/LLM_playground.rst:44
+msgid "Add or remove chat cards"
+msgstr "채팅 카드 추가 및 삭제"
+
+#: ../../LLM_playground/LLM_playground.rst:46
+msgid "To add new chat cards, click the '+' icon located in the top right corner."
+msgstr "우측 상단의 '+' 버튼을 클릭하여 새로운 채팅 카드를 추가할 수 있습니다."
+
+#: ../../LLM_playground/LLM_playground.rst:-1
+msgid "Add chat cards"
+msgstr "채팅 카드 추가 및 삭제"
+
+#: ../../LLM_playground/LLM_playground.rst:52
+msgid ""
+"To remove a chat session, click on the 'x' icon located in the upper "
+"right corner of the chat card. Please be cautious as this will delete all"
+" entered content."
+msgstr ""
+"각 채팅 세션을 삭제하려면 카드 우측 상단에 있는 'x' 버튼을 클릭하십시오. 입력한 내용이 존재하는 경우에는 "  
+"입력한 내용이 모두 삭제되므로 주의해 주세요." 
+
+#: ../../LLM_playground/LLM_playground.rst:-1
+msgid "Remove chatting cards"
+msgstr ""
+
+#: ../../LLM_playground/LLM_playground.rst:-1
+#: ../../LLM_playground/LLM_playground.rst:60
+msgid "Delete chat history"
+msgstr "채팅 기록 삭제"
+
+#: ../../LLM_playground/LLM_playground.rst:62
+msgid ""
+"Clicking the 'More' button will reveal the 'Delete Chat History' option. "
+"By selecting this, you will erase all chat history associated with the "
+"card, although the card session itself will remain active."
+msgstr ""
+"'더보기' 버튼을 클릭하면 'Delete Chat History' 버튼이 나타납니다. " 
+"이 버튼을 클릭하면 카드에 있는 모든 채팅 기록이 삭제됩니다. 단, 카드의 세션은 종료되지 않습니다."  
+
+#: ../../LLM_playground/LLM_playground.rst:-1
+#: ../../LLM_playground/LLM_playground.rst:71
+msgid "Synchronize input"
+msgstr "입력 연동"
+
+#: ../../LLM_playground/LLM_playground.rst:73
+msgid ""
+"The 'Sync Input' button located at the top right enables the "
+"synchronization of input across all chat cards. Enabling 'Sync input' "
+"means that pressing 'Enter' or clicking the 'Send' button on any card "
+"will submit the input from the card you are currently working on. This "
+"functionality is beneficial for comparing the outputs of various models "
+"using identical input data."
+msgstr ""
+"우측 상단의 'Sync input' 버튼을 사용하면 모든 채팅 카드의 입력을 동기화할 수 있습니다. 'Sync input'이 "
+"활성화된 채로, 'Enter'를 누르거나 어떤 카드의 'Send' 버튼을 클릭하면 현재 입력 중인 카드의 입력이 일괄 적용됩니다. "
+"이 기능은 하나의 입력값을 통해 다양한 모델의 응답 결과를 비교하고 싶을 때 유용하게 사용할 수 있습니다."
diff --git a/docs/locale/ko/LC_MESSAGES/installation/installation.po b/docs/locale/ko/LC_MESSAGES/installation/installation.po
@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: Backend.AI Console User Guide 19.09\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2021-03-02 18:11+0900\n"
+"POT-Creation-Date: 2024-09-23 15:24+0900\n"
 "PO-Revision-Date: 2021-03-02 18:16+0900\n"
 "Last-Translator: \n"
 "Language: ko\n"
@@ -17,63 +17,76 @@ msgstr ""
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=utf-8\n"
 "Content-Transfer-Encoding: 8bit\n"
-"Generated-By: Babel 2.8.0\n"
-"X-Generator: Poedit 2.4.2\n"
+"Generated-By: Babel 2.14.0\n"
 
 #: ../../installation/installation.rst:3
 msgid "Installation"
 msgstr "설치"
 
 #: ../../installation/installation.rst:5
+#, fuzzy
 msgid ""
-"The Web-UI can be used in two forms. It can be used as a web service by "
-"connecting to a separate web address prepared by the admins, or as an app "
-"provided as a stand-alone executable file that does not require separate "
-"installation."
+"Backend.AI WebUI can be used in two different forms. It can be used as a "
+"web service by connecting to a seperate web address provided by the "
+"admins, or as an form of app provided as a stand-alone executable file "
+"which does not require seperate installation."
 msgstr ""
-"Web-UI는 두 가지 형태로 사용할 수 있습니다. 관리자가 설치한 별도의 웹 주소로 접"
-"속하여 웹 서비스 형태로 이용할 수 있고, 별도 설치가 필요 없는 standalone 실행파"
-"일로 제공되는 앱 형태로 이용할 수도 있습니다."
+"Web-UI는 두 가지 형태로 사용할 수 있습니다. 관리자가 설치한 별도의 웹 주소로 접속하여 웹 서비스 형태로 이용할 수 있고, "
+"별도 설치가 필요 없는 standalone 실행파일로 제공되는 앱 형태로 이용할 수도 있습니다."
 
-#: ../../installation/installation.rst:10
+#: ../../installation/installation.rst:9
 msgid ""
-"With the web-based Web-UI, users do not need to install a platform-dependent "
-"desktop applications and just need the latest versions of browsers such as "
-"Chrome."
+"With web-based form of WebUI, users just need the latest versions of web "
+"browsers, no need to install platform-dependent desktop applications."
 msgstr ""
-"Web-UI는 관리자가 제공하는 별도의 웹 주소로 접속하여 웹 서비스 형태로 이용할 수 "
-"있습니다. 사용자는 플랫폼 의존적인 데스크톱 앱을 따로 설치할 필요가 없으며, "
-"Chrome 등과 같은 최신 브라우저만 있으면 설치하면 됩니다."
 
-#: ../../installation/installation.rst:14
-msgid "Recommended browser: the latest version of Chrome (at least version > 80)"
+#: ../../installation/installation.rst:11
+#, fuzzy
+msgid "Recommended browser: Latest version of Chrome (at least > 80)"
 msgstr "권장 브라우저: 최신 크롬 (최소한 버전 80 이상)"
 
-#: ../../installation/installation.rst:15
-msgid "Requirement: any machine that runs Web Browser (2 cores, 4 GiB memory)"
+#: ../../installation/installation.rst:12
+#, fuzzy
+msgid "Requirement: Any machine that runs web browser (2 cores, 4 GiB memory)"
 msgstr "요구사항: 웹 브라우저를 구동할 수 있는 머신 (2 코어, 4 GiB 메모리)"
 
-#: ../../installation/installation.rst:18
+#: ../../installation/installation.rst:15
+#, fuzzy
 msgid ""
-"We do not support MicroSoft Internet Explorer since it is deprecated and does "
-"not follow web standard and support up-to-date brower features."
+"We do not support Microsoft Internet Explorer since it is deprecated and "
+"does not follow web standard, and does not support up-to-date browser "
+"features."
 msgstr ""
-"마이크로소프트의 Internet Explorer 브라우저 개발이 중단되었고 웹 표준 및 최신 "
-"브라우저 기능을 충실히 따르지 않으므로 지원하지 않습니다."
+"마이크로소프트의 Internet Explorer 브라우저 개발이 중단되었고 웹 표준 및 최신 브라우저 기능을 충실히 따르지 않으므로"
+" 지원하지 않습니다."
 
-#: ../../installation/installation.rst:22
+#: ../../installation/installation.rst:18
+#, fuzzy
 msgid ""
-"The stand-alone Web-UI app can be downloaded from following address: https://"
-"github.com/lablup/backend.ai-webui/releases"
+"The stand-alone WebUI app can be downloaded from following link: "
+"https://github.com/lablup/backend.ai-webui/releases"
 msgstr ""
-"단독 앱 형태의 Web-UI는 다음 주소에서 다운로드할 수 있습니다: https://github."
-"com/lablup/backend.ai-webui/releases"
+"단독 앱 형태의 Web-UI는 다음 주소에서 다운로드할 수 있습니다: https://github.com/lablup/backend"
+".ai-webui/releases"
 
-#: ../../installation/installation.rst:26
+#: ../../installation/installation.rst:22
+#, fuzzy
 msgid ""
-"In the case of an app, depending on the security setting of the desktop OS, it "
-"may be recognized as an unsigned executable file and a permission check may be "
-"required."
-msgstr ""
-"앱 형태의 경우 데스크톱 운영체제의 보안 설정에 따라 서명되지 않은 실행파일로 인"
-"식되어 권한 허용 절차가 필요할 수 있습니다."
+"Depending on the security settings of the Operating System, our installer"
+" may be recognized as an unsigned executable file. Permission check may "
+"be required."
+msgstr "앱 형태의 경우 데스크톱 운영체제의 보안 설정에 따라 서명되지 않은 실행파일로 인식되어 권한 허용 절차가 필요할 수 있습니다."
+
+#~ msgid ""
+#~ "With the web-based Web-UI, users"
+#~ " do not need to install a "
+#~ "platform-dependent desktop applications and "
+#~ "just need the latest versions of "
+#~ "browsers such as Chrome."
+#~ msgstr ""
+#~ "Web-UI는 관리자가 제공하는 별도의 웹 주소로 "
+#~ "접속하여 웹 서비스 형태로 이용할 수 있습니다. "
+#~ "사용자는 플랫폼 의존적인 데스크톱 앱을 따로 설치할 "
+#~ "필요가 없으며, Chrome 등과 같은 최신 브라우저만 "
+#~ "있으면 설치하면 됩니다."
+