diff --git a/docs/apps.md b/docs/apps.md index a39f059c920d98579bb5e2428c4a1f334c23ca39..646c77f2443553f34bac6eb8f4fc2e7ac1a356ef 100644 --- a/docs/apps.md +++ b/docs/apps.md @@ -15,7 +15,7 @@ Gitee AI应用让您可以简单地在个人或组织资料页上直接展示AI - [Streamlit 应用](/apps/sdks-streamlit) - [静态应用](/apps/sdks-static) - [Docker 应用](/apps/sdks-docker) -- [配置参考](/apps/config-reference) +- [应用问答](/apps/qa) ## 联系我们 diff --git a/docs/apps/config-reference.md b/docs/apps/config-reference.md deleted file mode 100644 index e6aa17660dc9679fcec16213d634a590f8b11f5d..0000000000000000000000000000000000000000 --- a/docs/apps/config-reference.md +++ /dev/null @@ -1,74 +0,0 @@ -# 配置参考 - - diff --git a/docs/apps/overview.md b/docs/apps/overview.md index 8cd7f4ec0927196fe1075a97c4383ebe8dd6e566..86bb146a0891acc9d50ae6adf7fc089993107dfb 100644 --- a/docs/apps/overview.md +++ b/docs/apps/overview.md @@ -14,7 +14,7 @@ Gitee AI的应用功能让您能够在几分钟内轻松创建和部署由ML驱 ![alt text](/img/app/apps_gradio.png) -在构建上,如同模型和数据集一样,您的代码是被存储在了一个 git 仓库。因此,大部分的仓库管理工具(git 和 git-lfs)也适用于您的**应用**。如果需要添加文件到您的**应用**时,请遵循“[推送仓库](/repositories#推送仓库)”中的相同流程。每次推送新的提交时,**应用**都会提示您重新启动,否则您的提交不会影响到正在运行的应用。 +在构建上,如同模型和数据集一样,您的代码是被存储在了一个 git 仓库。使用 git 和 git-lfs 可以管理您的**应用**仓库代码。如果需要添加文件到您的**应用**时,请遵循“[推送仓库](/repositories#推送仓库)”中的相同流程。每次推送新的提交时,**应用**界面都会提示您重新启动,如不重启,应用不会更新。 ## 硬件资源 @@ -24,9 +24,9 @@ Gitee AI的应用功能让您能够在几分钟内轻松创建和部署由ML驱 ## 管理密钥和环境变量 -如果您的应用需要使用环境变量(例如,密钥或令牌),请不要在应用的代码中硬编码这些信息!您应该进入您的**应用**“设置”页面,并添加新的变量或密钥(Secret)。如果您需要存储非敏感的配置键值对,请使用应用变量;如果需要存储访问令牌、API 密钥或任何敏感信息或凭证,请使用应用密钥。 +如果您的应用需要使用环境变量(例如,密钥或令牌),为了防止泄露,请不要在应用的代码中硬编码这些信息!您应该进入您的**应用**“设置”页面,并添加新的变量或密钥(Secret)。如果您需要存储非敏感的配置键值对,请使用应用变量;如果需要存储访问令牌、API 密钥或任何敏感信息或凭证,请使用应用密钥。 -应用变量是公开可访问和可查看的,会自动添加到从您仓库复制的**应用**中。它们将作为环境变量暴露给您的应用程序。 +应用变量是公开可访问和可查看的,会自动添加到从您仓库 Fork 的**应用**中。它们将作为环境变量暴露给您的应用程序。 ![alt text](/img/app/apps_secret.png) @@ -42,7 +42,7 @@ Gitee AI的应用功能让您能够在几分钟内轻松创建和部署由ML驱 ## 仓库克隆 -您可以轻松地在本地克隆应用的仓库,首先请点击应用页面右上角的“克隆应用”: +您可以在本地克隆应用的仓库,首先请点击应用页面右上角的“克隆应用”: ![alt text](/img/app/apps_git_copy.png) diff --git a/docs/apps/qa.md b/docs/apps/qa.md new file mode 100644 index 0000000000000000000000000000000000000000..5be4f5ce38f0f9575a18d34ccbe3dcc1951adcd0 --- /dev/null +++ b/docs/apps/qa.md @@ -0,0 +1,76 @@ +# 应用问答 + +### 应用显示 Running 为什么页面没有响应? +- 如果您查看日志,应用运行正常,您可以检查您的应用是否运行在 **7860** 端口。 +- 或者检查应用是否运行在 **0.0.0.0** ip 上,如果是其他特定的 ip, 则可能无法访问。 + +### 为什么我的应用会出现 CORS、CRSF 等报错,导致页面无法访问? +- 您需要取消应用的访问限制,例如 jupyter-lab, 存在配置 `--NotebookApp.allow_remote_access=True` 允许远程访问,`--NotebookApp.allow_origin=*` 允许跨域请求。 +Streamlit 也有类似的配置,例如 +``` +ENTRYPOINT ["streamlit", "run", "app.py", \ + "--server.port=7860",\ + "--server.enableCORS=false", \ + "--server.headless=true", \ + "--server.enableXsrfProtection=false", \ + "--server.fileWatcherType=none", \ + "--global.developmentMode=false", \ + "--server.enableWebsocketCompression=false", \ + "--browser.gatherUsageStats=false"] +``` +通常这些配置都可添加到启动参数上。 + +### 如何排查错误 +您可以点击界面的日志按钮,查询日志信息,以及提供的运行时信息。将会提供当前状态的原因、消息,上次启动失败的报错信息、重启次数、退出码等。 + +![Alt text](../../static/img/app/qa/error_log.png) + +### 为什么我的应用一直在 Pengding 状态? +可能是正在分配资源,或平台 CPU、内存资源不足,请耐心等待 + + +### 应用设置中的“出厂重启”和“重启”有什么区别? +|类型|出厂重启|重启| +|-|-|-| +|是否拉取仓库最新代码|是|否| +|是否重新构建|是|否| +|是否重新下载依赖|是|否| +|是否重新执行仓库代码|是|是| +|是否更新硬件配置|是|是| +|是否更新环境变量|是|是| + +如果您更新了仓库代码,应用将会识别并在界面顶部提示重启,此时重启与出厂重启效果一致。 + + +### 如何在应用中使用环境变量、秘钥? + +您可以正常使用代码获取系统环境变量。 +> 注意,秘钥也会作为环境变量注入,但秘钥被设置后不可见,也无法被 Fork。 + +以 Python 为例,获取环境变量: +如果您在应用设置中添加了 键: `G_TOKEN` 值:`b53de003db22348606b` + +```python +import os +G_TOKEN = os.getenv('G_TOKEN') +print(G_TOKEN) # 输出: b53de003db22348606b +``` + +### 下载依赖镜像源可以自定义吗? +Gitee AI 默认使用了国内镜像源,您可以自行修改镜像源地址加速,例如 Python requirements.txt 文件: +``` +--extra-index-url https://mirrors.aliyun.com/pytorch-wheels/cu121 +torch==2.1.1 +``` +推荐使用的国内源源: +- 腾讯 https://mirrors.cloud.tencent.com/pypi/simple +- 阿里 https://mirrors.aliyun.com/pypi/simple/ +- 中国科技大学 https://pypi.mirrors.ustc.edu.cn/simple/ +- 清华大学 https://pypi.tuna.tsinghua.edu.cn/simple/ + +### 免费存储空间是多少?存储的数据会消失吗? +目前应用免费临时存储为 60GB,如果您未购买持久存储,则临时存储在应用重启时会被清空。 + +### 如何让我的应用被推荐? +如果您开发了优秀、好玩、有趣的应用,您可以前往 [反馈](https://gitee.com/gitee-ai/feedback/issues) 提供应用信息申请 + diff --git a/docs/apps/sdks-static.md b/docs/apps/sdks-static.md index 00a8866187b3809712956b5b3d3d5e5f47bce9a4..3612b541f3f983f8743214a2e17c3b88f855173d 100644 --- a/docs/apps/sdks-static.md +++ b/docs/apps/sdks-static.md @@ -4,14 +4,11 @@ ![alt text](/img/app/image-2.png) -或者将 sdk:static 设置在您 `README.md` 文件顶部的 **YAML** 区块内,然后您再创建一个 `index.html` 文件并放置好 HTML 代码。 - -![alt text](/img/app/image-3.png) ![alt text](/img/app/image-4.png) 下面是使用 HTML 构建应用的例子: -- [transformers-js-object-detection](https://ai.gitee.com/apps/stringify/transformers-js-object-detection):对象区域检测 +- [transformers-js-object-detection](https://ai.gitee.com/apps/stringify/static-app_object-detection): 物体区域检测 ![alt text](/img/app/image-1.png) \ No newline at end of file diff --git a/sidebars.ts b/sidebars.ts index eba690d5c8ed93c46af381e08b535002606016d1..c2c4137b2b24c692c31523f26092d379e8b622ab 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -140,7 +140,7 @@ const sidebars: SidebarsConfig = { }, { type: 'doc', - id: 'apps/config-reference', + id: 'apps/qa', }, ], }, diff --git a/static/img/app/image-1.png b/static/img/app/image-1.png index 81c9b82261499fef288623ea322863fe1b7c5e57..2a5d6bad3c14a56fc9de3e0750b9e70aaada8fb5 100644 Binary files a/static/img/app/image-1.png and b/static/img/app/image-1.png differ diff --git a/static/img/app/qa/error_log.png b/static/img/app/qa/error_log.png new file mode 100644 index 0000000000000000000000000000000000000000..fb7f78e7d83644f9fa756cee444538b5cf696e1d Binary files /dev/null and b/static/img/app/qa/error_log.png differ