文档和源码注释问题


如题目所见,这里是一些反馈问题:

1、注释问题。比如optim.py模块optimizer的源码pos_step、pre_step的描述内容一样,举的例子中比如self.pos_step(loss)一行有参数loss,可实际上该方法似乎并不接收参数。

2、文档问题。文档中有一些api(比如jittor — Jittor 1.3.4.10 文档

3、提示问题。以及比如unbind方法,已有可以jt.unbind(var,dim)调用,也可以var.unbind(dim)调用,可是(就我个人使用而言)在写代码时候var.unbind(dim)方法没有提示,可能会使新手用户以为不存在类似调用。

个人感觉这些小问题可能会给新手入门制造门槛,对新手不太友好,这些看似简单的地方最可能成为木桶的短板,建议可以参考pytorch的文档完善jittor文档、注释和提示。

当然以上仅是个人感受,希望jittor越来越好!

感谢您的反馈,您的意见对 Jittor 非常宝贵。

我们已经根据您的建议更正了 post_step 的文档;代码提示不全的问题是因为 python 存根文件版本落后于代码,这一点将会在未来版本的 Jittor 中改进。

jittor 目前文档确实存在不完美之处。如果您对于具体的某个函数用法有疑问,欢迎继续发帖提问,我们尽力解答,并改进文档。

同时也非常欢迎提交 pull request 提交文档的改进,成为Jittor开发者的一员,促进 Jittor 的成长。