Browse Source

docs: specify absolute path for model weights configuration

Update the README documents to clarify that the "models-dir" in the
configuration should be an absolute path. Also, provide additional guidance
for Windows users on how to correctly format the path to avoid common issues
with path escaping in JSON files.
myhloli 1 year ago
parent
commit
9778a46142

+ 4 - 2
README_zh-CN.md

@@ -135,9 +135,11 @@ cp magic-pdf.template.json ~/magic-pdf.json
 ```
 
 在用户目录中找到magic-pdf.json文件并配置"models-dir"为[2. 下载模型权重文件](#2-下载模型权重文件)中下载的模型权重文件所在目录
-> ❗️务必正确配置模型权重文件所在目录,否则会因为找不到模型文件而导致程序无法运行
+> ❗️务必正确配置模型权重文件所在目录的【绝对路径】,否则会因为找不到模型文件而导致程序无法运行
 > 
-> windows系统中应把路径中所有的"\\"替换为"/",否则会因为转义原因导致json文件语法错误。
+> windows系统中此路径应包含盘符,且需把路径中所有的"\"替换为"/",否则会因为转义原因导致json文件语法错误。
+> 
+> 例如:模型放在D盘根目录的models目录,则model-dir的值应为"D:/models"
 ```json
 {
   "models-dir": "/tmp/models"

+ 4 - 2
README_zh-CN_v2.md

@@ -196,9 +196,11 @@ cp magic-pdf.template.json ~/magic-pdf.json
 ```
 
 在用户目录中找到magic-pdf.json文件并配置"models-dir"为[2. 下载模型权重文件](#2-下载模型权重文件)中下载的模型权重文件所在目录
-> ❗️务必正确配置模型权重文件所在目录,否则会因为找不到模型文件而导致程序无法运行
+> ❗️务必正确配置模型权重文件所在目录的【绝对路径】,否则会因为找不到模型文件而导致程序无法运行
+>
+> windows系统中此路径应包含盘符,且需把路径中所有的"\"替换为"/",否则会因为转义原因导致json文件语法错误。
 > 
-> windows系统中应把路径中所有的"\\"替换为"/",否则会因为转义原因导致json文件语法错误。
+> 例如:模型放在D盘根目录的models目录,则model-dir的值应为"D:/models"
 ```json
 {
   "models-dir": "/tmp/models"

+ 1 - 1
docs/README_Ubuntu_CUDA_Acceleration_zh_CN.md

@@ -73,7 +73,7 @@ cp magic-pdf.template.json ~/magic-pdf.json
 ```
 
 在用户目录中找到magic-pdf.json文件并配置"models-dir"为[7. 下载模型](#7-下载模型)中下载的模型权重文件所在目录
-> ❗️务必正确配置模型权重文件所在目录,否则会因为找不到模型文件而导致程序无法运行
+> ❗️务必正确配置模型权重文件所在目录的【绝对路径】,否则会因为找不到模型文件而导致程序无法运行
 > 
 ```json
 {

+ 4 - 1
docs/README_Windows_CUDA_Acceleration_zh_CN.md

@@ -47,8 +47,11 @@ cp magic-pdf.template.json ~/magic-pdf.json
 ```
 
 在用户目录中找到magic-pdf.json文件并配置"models-dir"为[5. 下载模型](#5-下载模型)中下载的模型权重文件所在目录
-> ❗️务必正确配置模型权重文件所在目录,否则会因为找不到模型文件而导致程序无法运行
+> ❗️务必正确配置模型权重文件所在目录的【绝对路径】,否则会因为找不到模型文件而导致程序无法运行
 > 
+> windows系统中此路径应包含盘符,且需把路径中所有的"\"替换为"/",否则会因为转义原因导致json文件语法错误。
+> 
+> 例如:模型放在D盘根目录的models目录,则model-dir的值应为"D:/models"
 ```json
 {
   "models-dir": "/tmp/models"