我对 sphinx 比较陌生,想为我的项目生成文档。我的函数之一的示例可以在 Predict.py 中找到:
def arima_rolling_forecast(training_set, testing_set, order, solver='lbfgs'):
"""
Runs an ARIMA rolling forecast with a given training and testing set.
:param pandas.Series training_set: training set.
:param pandas.Series testing_set: testing set.
:param collections.namedtuple order: ARIMA order (p, d, q).
:param string solver: the solver used for the rolling average. Defaults to lbfgs.
:return: the forecast of predicted values.
:rtype: list
"""
previous_results = list(training_set)
predictions = []
for result in testing_set:
tmp_model = ARIMA(previous_results, order=order)
tmp_model_fit = tmp_model.fit(disp=False, solver=solver)
forecast, _, _ = tmp_model_fit.forecast()
predictions.append(forecast[0])
previous_results.append(result)
return predictions
When I use the make html
command, the documentation is almost correct, however the return type and params are appended to function description as seen below:
我该如何改变这个,以便param
return
and rtype
放在单独的行上吗?或者这就是文档的样子?
您需要在描述和第一个之间添加一个空行:param blah blah:
。请参阅语法信息字段列表.
我不确定是否支持 pandas 数据类型。您需要自己进行研究才能做出决定。
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)