如何解决在哪里可以找到 Github 上模块缺少的 Python API/文档?
我对 Python 还很陌生,我正在努力了解保存到 Github 的模块文档。
我的案例是模块 SimpSOM (https://github.com/fcomitani/SimpSOM)。我安装了该模块并尝试了 Github 页面和链接的 readthedocs 页面上提供的基本介绍示例。
不幸的是,我立即遇到了以下问题:
import pandas as pd
import numpy as np
import SimpSOM as sps
from sklearn.cluster import KMeans
#training
net = sps.somNet(20,20,raw_data,PBC=True)
返回错误:
NameError: name 'raw_data' is not defined
我不认为 raw_data 不是 SimpSOM 模块的一部分,它可能只是示例袋的占位符名称,我在相应的网站中找不到任何提及 raw_data 的内容/文档。但是,Google 显示了以下页面:https://pydoc.net/SimpSOM/1.3.1/SimpSOM/ 并带有以下代码:
class somNet:
""" Kohonen SOM Network class. """
def __init__(self,netHeight,netWidth,data,loadFile=None,PCI=0,PBC=0):
"""Initialise the SOM network.
Args:
netHeight (int): Number of nodes along the first dimension.
netWidth (int): Numer of nodes along the second dimension.
data (np.array or list): N-dimensional dataset.
....
我有几个问题:
- 我疲惫的眼睛是否错过了完整的 API 文档?
- 我可以从评论中看到 raw_data 实际上是 data 类型为 np.array 或 list。如果模块缺少文档,是否有任何方法可以通过编程方式查询类模块或函数以查看预期的数据类型?
- 最坏的情况是,我如何从该类中的注释生成我自己的文档?看起来它们与 doxygen 兼容。
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。