improve built-in user guides

frontend/src/_locales/zh-hans/main.json

@@ -16,7 +16,7 @@
   "Stored Layers": "载入显存层数",
   "Precision": "精度",
   "Device": "设备",
-  "Convert model with these configs": "用这些设置转换模型",
+  "Convert model with these configs. Using a converted model will greatly improve the loading speed, but model parameters of the converted model cannot be modified.": "用这些设置转换模型. 使用转换过的模型能大大提升载入速度, 但是转换后的模型无法再修改模型参数.",
   "Manage Models": "管理模型",
   "Model": "模型",
   "Model Parameters": "模型参数",
@@ -78,12 +78,12 @@
   "Update Error": "更新出错",
   "Open the following URL with your browser to view the API documentation": "使用浏览器打开以下地址查看API文档",
   "By default, the maximum number of tokens that can be answered in a single response, it can be changed by the user by specifying API parameters.": "默认情况下, 单个回复最多回答的token数目, 用户可以通过自行指定API参数改变这个值",
-  "Sampling temperature, the higher the stronger the randomness and creativity, while the lower, the more focused and deterministic it will be.": "采样温度, 越大随机性越强, 更具创造力, 越小则越保守稳定",
-  "Consider the results of the top n% probability mass, 0.1 considers the top 10%, with higher quality but more conservative, 1 considers all results, with lower quality but more diverse.": "考虑前 n% 概率质量的结果, 0.1 考虑前 10%, 质量更高, 但更保守, 1 考虑所有质量结果, 质量降低, 但更多样",
+  "Sampling temperature, it's like giving alcohol to a model, the higher the stronger the randomness and creativity, while the lower, the more focused and deterministic it will be.": "采样温度, 就像给模型喝酒, 越大随机性越强, 更具创造力, 越小则越保守稳定",
+  "Just like feeding sedatives to the model. Consider the results of the top n% probability mass, 0.1 considers the top 10%, with higher quality but more conservative, 1 considers all results, with lower quality but more diverse.": "就像给模型喂镇静剂. 考虑前 n% 概率质量的结果, 0.1 考虑前 10%, 质量更高, 但更保守, 1 考虑所有质量结果, 质量降低, 但更多样",
   "Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.": "存在惩罚. 正值根据新token在至今的文本中是否出现过, 来对其进行惩罚, 从而增加了模型涉及新话题的可能性",
   "Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.": "频率惩罚. 正值根据新token在至今的文本中出现的频率/次数, 来对其进行惩罚, 从而减少模型原封不动地重复相同句子的可能性",
   "int8 uses less VRAM, but has slightly lower quality. fp16 has higher quality, and fp32 has the best quality.": "int8占用显存更低, 但质量略微下降. fp16质量更好, fp32质量最好",
-  "Number of the neural network layers loaded into VRAM, the more you load, the faster the speed, but it consumes more VRAM.": "载入显存的神经网络层数, 载入越多, 速度越快, 但显存消耗越大",
+  "Number of the neural network layers loaded into VRAM, the more you load, the faster the speed, but it consumes more VRAM. (If your VRAM is not enough, it will fail to load)": "载入显存的神经网络层数, 载入越多, 速度越快, 但显存消耗越大 (如果你的显存不够, 会载入失败)",
   "Whether to use CPU to calculate the last output layer of the neural network with FP32 precision to obtain better quality.": "是否使用cpu以fp32精度计算神经网络的最后一层输出层, 以获得更好的质量",
   "Downloads": "下载",
   "Pause": "暂停",
@@ -100,7 +100,7 @@
   "Model Config Exception": "模型配置异常",
   "Use Gitee Updates Source": "使用Gitee更新源",
   "Use Custom CUDA kernel to Accelerate": "使用自定义CUDA算子加速",
-  "Enabling this option can greatly improve inference speed, but there may be compatibility issues. If it fails to start, please turn off this option.": "开启这个选项能大大提升推理速度，但可能存在兼容性问题，如果启动失败，请关闭此选项",
+  "Enabling this option can greatly improve inference speed and save some VRAM, but there may be compatibility issues. If it fails to start, please turn off this option.": "开启这个选项能大大提升推理速度并节省显存，但可能存在兼容性问题，如果启动失败，请关闭此选项",
   "Supported custom cuda file not found": "没有找到支持的自定义cuda文件",
   "Failed to copy custom cuda file": "自定义cuda文件复制失败",
   "Downloading update, please wait. If it is not completed, please manually download the program from GitHub and replace the original program.": "正在下载更新，请等待。如果一直未完成，请从Github手动下载并覆盖原程序",
@@ -137,7 +137,7 @@
   "Custom Models Path": "自定义模型路径",
   "Microsoft Visual C++ Redistributable is not installed, would you like to download it?": "微软VC++组件未安装, 是否下载?",
   "Path Cannot Contain Space": "路径不能包含空格",
-  "Failed to switch model, please try starting the program with administrator privileges.": "切换模型失败, 请尝试以管理员权限启动程序",
+  "Failed to switch model, please try starting the program with administrator privileges or increasing your virtual memory.": "切换模型失败, 请尝试以管理员权限启动程序, 或增加你的虚拟内存",
   "Current Strategy": "当前Strategy",
   "MacOS is not yet supported for performing this operation, please do it manually.": "MacOS尚未支持此操作, 请手动执行",
   "Linux is not yet supported for performing this operation, please do it manually.": "Linux尚未支持此操作, 请手动执行",

frontend/src/components/RunButton.tsx

@@ -191,7 +191,7 @@ export const RunButton: FC<{ onClickRun?: MouseEventHandler, iconMode?: boolean
             }).catch(() => {
               commonStore.setStatus({ status: ModelStatus.Offline });
               if (commonStore.platform === 'windows')
-                toast(t('Failed to switch model, please try starting the program with administrator privileges.'), { type: 'error' });
+                toast(t('Failed to switch model, please try starting the program with administrator privileges or increasing your virtual memory.'), { type: 'error' });
               else
                 toast(t('Failed to switch model'), { type: 'error' });
             });

frontend/src/pages/Completion.tsx

@@ -272,7 +272,7 @@ const CompletionPanel: FC = observer(() => {
                 }} />
             } />
           <Labeled flex breakline label={t('Temperature')}
-            desc={t('Sampling temperature, the higher the stronger the randomness and creativity, while the lower, the more focused and deterministic it will be.')}
+            desc={t('Sampling temperature, it\'s like giving alcohol to a model, the higher the stronger the randomness and creativity, while the lower, the more focused and deterministic it will be.')}
             content={
               <ValuedSlider value={params.temperature} min={0} max={2} step={0.1}
                 input
@@ -283,7 +283,7 @@ const CompletionPanel: FC = observer(() => {
                 }} />
             } />
           <Labeled flex breakline label={t('Top_P')}
-            desc={t('Consider the results of the top n% probability mass, 0.1 considers the top 10%, with higher quality but more conservative, 1 considers all results, with lower quality but more diverse.')}
+            desc={t('Just like feeding sedatives to the model. Consider the results of the top n% probability mass, 0.1 considers the top 10%, with higher quality but more conservative, 1 considers all results, with lower quality but more diverse.')}
             content={
               <ValuedSlider value={params.topP} min={0} max={1} step={0.1} input
                 onChange={(e, data) => {

frontend/src/pages/Configs.tsx

@@ -166,7 +166,7 @@ export const Configs: FC = observer(() => {
                       }} />
                   } />
                 <Labeled label={t('Temperature') + ' *'}
-                  desc={t('Sampling temperature, the higher the stronger the randomness and creativity, while the lower, the more focused and deterministic it will be.')}
+                  desc={t('Sampling temperature, it\'s like giving alcohol to a model, the higher the stronger the randomness and creativity, while the lower, the more focused and deterministic it will be.')}
                   content={
                     <ValuedSlider value={selectedConfig.apiParameters.temperature} min={0} max={2} step={0.1}
                       input
@@ -177,7 +177,7 @@ export const Configs: FC = observer(() => {
                       }} />
                   } />
                 <Labeled label={t('Top_P') + ' *'}
-                  desc={t('Consider the results of the top n% probability mass, 0.1 considers the top 10%, with higher quality but more conservative, 1 considers all results, with lower quality but more diverse.')}
+                  desc={t('Just like feeding sedatives to the model. Consider the results of the top n% probability mass, 0.1 considers the top 10%, with higher quality but more conservative, 1 considers all results, with lower quality but more diverse.')}
                   content={
                     <ValuedSlider value={selectedConfig.apiParameters.topP} min={0} max={1} step={0.1} input
                       onChange={(e, data) => {
@@ -237,7 +237,9 @@ export const Configs: FC = observer(() => {
                     }} />
                   </div>
                 } />
-                <ToolTipButton text={t('Convert')} desc={t('Convert model with these configs')} onClick={async () => {
+                <ToolTipButton text={t('Convert')}
+                  desc={t('Convert model with these configs. Using a converted model will greatly improve the loading speed, but model parameters of the converted model cannot be modified.')}
+                  onClick={async () => {
                     if (commonStore.platform == 'darwin') {
                       toast(t('MacOS is not yet supported for performing this operation, please do it manually.'), { type: 'info' });
                       return;
@@ -266,7 +268,7 @@ export const Configs: FC = observer(() => {
                       toast(`${t('Model Not Found')} - ${modelPath}`, { type: 'error' });
                     }
                   }} />
-                <Labeled label={t('Device')} content={
+                <Labeled label={t('Strategy')} content={
                   <Dropdown style={{ minWidth: 0 }} className="grow" value={t(selectedConfig.modelParameters.device)!}
                     selectedOptions={[selectedConfig.modelParameters.device]}
                     onOptionSelect={(_, data) => {
@@ -310,7 +312,7 @@ export const Configs: FC = observer(() => {
                 {
                   selectedConfig.modelParameters.device == 'CUDA' &&
                   <Labeled label={t('Stored Layers')}
-                    desc={t('Number of the neural network layers loaded into VRAM, the more you load, the faster the speed, but it consumes more VRAM.')}
+                    desc={t('Number of the neural network layers loaded into VRAM, the more you load, the faster the speed, but it consumes more VRAM. (If your VRAM is not enough, it will fail to load)')}
                     content={
                       <ValuedSlider value={selectedConfig.modelParameters.storedLayers} min={0}
                         max={selectedConfig.modelParameters.maxStoredLayers} step={1} input
@@ -349,7 +351,7 @@ export const Configs: FC = observer(() => {
                 {
                   selectedConfig.modelParameters.device != 'CPU' && selectedConfig.modelParameters.device != 'MPS' &&
                   <Labeled label={t('Use Custom CUDA kernel to Accelerate')}
-                    desc={t('Enabling this option can greatly improve inference speed, but there may be compatibility issues. If it fails to start, please turn off this option.')}
+                    desc={t('Enabling this option can greatly improve inference speed and save some VRAM, but there may be compatibility issues. If it fails to start, please turn off this option.')}
                     content={
                       <Switch checked={selectedConfig.modelParameters.useCustomCuda}
                         onChange={(e, data) => {