Conversation
Agent-Logs-Url: https://github.com/ZhulongNT/SwanLab-Docs/sessions/5ed6d67e-a526-4ffe-8a4a-88b7d4c1330d Co-authored-by: ZhulongNT <191720247+ZhulongNT@users.noreply.github.com>
There was a problem hiding this comment.
Code Review
This pull request introduces a new public/llms.txt file providing a comprehensive overview of SwanLab, its features, Python SDK API reference, CLI tools, and integration guides. The review feedback points out an inconsistency in the URL casing for the Image, Audio, and Text API documentation links, which should be corrected to lowercase to ensure compatibility with case-sensitive web servers and maintain consistency with other links in the document.
| - [swanlab.Image](https://docs.swanlab.cn/en/api/py-Image.html): Wrap image data (file path, numpy array, or PIL image) for logging. | ||
| - [swanlab.Audio](https://docs.swanlab.cn/en/api/py-Audio.html): Wrap audio data for logging. | ||
| - [swanlab.Text](https://docs.swanlab.cn/en/api/py-Text.html): Wrap text (with optional Markdown rendering) for logging. |
There was a problem hiding this comment.
The URLs for swanlab.Image, swanlab.Audio, and swanlab.Text use capitalized slugs (py-Image.html, py-Audio.html, py-Text.html), which is inconsistent with the rest of the file (e.g., py-video.html, py-echarts.html) and the project's general naming convention for documentation files. This may lead to broken links on case-sensitive web servers.
- [swanlab.Image](https://docs.swanlab.cn/en/api/py-image.html): Wrap image data (file path, numpy array, or PIL image) for logging.
- [swanlab.Audio](https://docs.swanlab.cn/en/api/py-audio.html): Wrap audio data for logging.
- [swanlab.Text](https://docs.swanlab.cn/en/api/py-text.html): Wrap text (with optional Markdown rendering) for logging.
|
fix #275 |
Agent-Logs-Url: https://github.com/ZhulongNT/SwanLab-Docs/sessions/5ed6d67e-a526-4ffe-8a4a-88b7d4c1330d