我如何使用狮身人面像与Tensorflow和numpydoc？

Question

这里的主要问题是哪里(如果)有一个objects.inv为TensorFlow，但如何实际使用它将是一个很好的例子。

例如，我目前有以下docstring：

"""
Load the weights of a model stored in saver.

Parameters
----------
checkpoint_dir : str
    The directory of checkpoints.
sess : tf.Session
    A Session to use to restore the parameters.
saver : tf.train.Saver
"""

如何使用intersphinx自动将对象链接到TensorFlow文档？

Answer 1

更新(2020年5月30日)：Tensorflow 2.0的Python (而不是JS、C++或Java)的 Github用户"mr-ubik“已经组装了一个包来自动生成objects.inv，可以找到这里。存储库拥有objects.inv文件本身和用于创建它的工具，以及用于将其链接到文档的intersphinx_mapping元素。

更新(2021年3月16日)： Per 评论，STJ继续开发用于在https://github.com/GPflow/tensorflow-intersphinx/中自动生成Tensorflow的objects.inv的工具。清单现在的目标是TensorFlow v2.4，包括TensorFlow概率v0.12。

mzjn是对的 --如果文档不是狮身人面像生成的，就不会有一个objects.inv文件可以找到。

但是，您可以创建自己的objects.inv来使用Tensorflow。我编写了一个Python包，让我和如何操作指令一起完成这个任务。简单地说，并指出这里的一些细节可能不完全正确：

1. 导入sphobjinv并创建一个空的Inventory将sphobjinv导入为soi >>> inv = soi.Inventory()
2. 定义狮身人面像头信息：inv.project =‘Tensorflow >>> inv.version = '2.2’
3. 为希望包含的每个对象将sphobjinv.DataObjStr实例追加到Inventory的objects成员：O=soi.DataObjStr(名称=‘tf.autodiff’，域=‘py’，角色=‘模块’，.优先级=‘1’，uri='python/tf/autodiff'，dispname='-') >>> inv.objects.append(o) >>> print(inv) <>>>(手册)：foobar v1.5，1 objects> {name}通常是完全限定的对象名称.Python、C++和Javascript部分文档可以由默认的python、cpp和js Sphinx域处理，但是您必须使用创建您自己的Sphinx域 for Java。(不幸的是，提供了这样一个域的项目已经被废弃了。)对于被记录的每个对象(例如，function、method等等，对于py域，{role}将是适用于任何合适的指令)。{priority}也会影响库存中的对象在内部文档搜索中的显示方式，并且在这种情况下应该总是1。{relative uri}相对于您将包含在conf.py中的intersphinx_mapping参数中的基本URI (参见下面)。{displayname}通常也是完全限定的对象名称.
4. 生成和压缩库存内容，并写入磁盘：text = inv.data_file(contract=True) >>> ztext = soi.compress(text) >>> soi.writebytes(‘objects_tensorflow.inv.text’，ztext)
5. 上传到一个方便的，可访问的位置。
6. 配置间狮身人面像： intersphinx_mapping ={ 'tensorflow‘=( '博士/‘，’uri/to/objects_tensorflow.uri‘，)}

这样就行了。这有点费时费力，必须手动组合文件，但如果您只是根据需要添加对象，那么应该不会太糟糕。或者，您可以刮掉文档页面集并自动生成库存(就像mr-ubik所做的那样)。