Где найти недостающий API/документацию Python для модуля на Github? ⇐ Python

[Anonymous]

Я новичок в 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: имя «raw_data» не определено

Я не думаю, что 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 на самом деле является данными типа np.array или list< /эм>. Если для модуля отсутствует документация, есть ли способ программно запросить модуль класса или функцию, чтобы узнать, какие типы данных ожидаются?
• В худшем случае, как я могу создать свою собственную документацию из комментариев внутри этого класса? Похоже, они совместимы с doxygen.

Подробнее здесь: https://stackoverflow.com/questions/660 ... -on-github