More documentation problems
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 48/100
- Issue 类型
- 缺陷
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- python
调研方向
从 SpinSystemInfo API 文档页面开始，将其中缺失的属性描述与 v0.5.1 中 tensorflow_quantum/datasets/spin_system.py 的定义进行比较。跟踪该源文件如何转换为 TensorFlow Quantum 网站文档，然后验证生成的页面是否呈现了所有属性描述。
由索引模型根据 Issue 内容生成。
描述
While there are still problems with the rendering of the new math ops (see https://github.com/tensorflow/quantum/issues/594), I found what I think is another documentation problem on the tfq website. The descriptions for the attributes of tfq.datasets.spin_system.SpinSystemInfo (https://www.tensorflow.org/quantum/api_docs/python/tfq/datasets/spin_system/SpinSystemInfo) are all missing. This is the only place on the tfq website where the little description boxes have labels but no descriptions (see the attached picture to if this explanation is not clear).
Additionally, since the attribute descriptions exist in the code (see https://github.com/tensorflow/quantum/blob/v0.5.1/tensorflow_quantum/datasets/spin_system.py#L25) I assume this is a bug.
- 主要语言
- Python
- 星标
- 2.2k
- 派生
- 674
- 平均合并
- 1 天 14 小时
- 30 天内合并 PR
- 5
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
tensorflow/quantum 的其他 Issue
-
area/c++ area/core kind/bug-report
难度 2/5 1-3 小时 新手友好度 78/100
tensorflow/quantum#1140 ·
维护者通常 1 天内回复
-
Avoid hard-coding "quantum" in `scripts/` scripts可能已有人在做 @openbotgit 于 23 天前认领。 未关闭area/devops help wanted no QC knowledge needed priority/before-0.7.7
难度 2/5 1-3 小时 新手友好度 68/100
tensorflow/quantum#1082 · 2 条评论 · 1 个 reaction ·
维护者通常 1 天内回复
-
area/c++ area/core kind/bug-report
难度 3/5 1-2 天 新手友好度 74/100
tensorflow/quantum#1141 ·
维护者通常 1 天内回复
-
Bug (likely typo) in `core/serialize/serializer_test.py`可能已有人在做 @mhucka 于 15 天前认领。 未关闭area/serialization area/tests
tensorflow/quantum#1129 · 已指派 1 人 ·
维护者通常 1 天内回复
-
Support Keras 3可能重新可做 @rosspeili 于 118 天前认领，目前没有进行中的 PR。 未关闭area/keras help wanted skill-level/intermediate
tensorflow/quantum#1090 · 5 条评论 · 已指派 1 人 ·
维护者通常 1 天内回复
查看 tensorflow/quantum 的全部 Issue
相似的 Issue
-
release
难度 2/5 1-3 小时 新手友好度 76/100
MichaelYcJo/SpecSeal#1535 ·
-
bug
难度 2/5 1-3 小时 新手友好度 82/100
valentinfrlch/ha-llmvision#769 ·
维护者通常 1 天内回复
-
bug
难度 1/5 1 小时以内 新手友好度 75/100
daniel-ospina/tortoise#11937 · 1 条评论 ·
维护者通常 1 天内回复
-
good first issue help wanted python up-for-grabs
难度 2/5 1-3 小时 新手友好度 82/100
andrewsiah/agentswarm-data-tasks#238 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 70/100
cadence-workflow/cadence-ai-samples#175 ·
维护者通常 1 天内回复