documentation - 如何获取 pyomo 函数、方法等的信息/帮助

Question

首先，我是 python 和 pyomo 的新手（但对 Matlab、C、R 和一些面向硬件的语言有一些基本的了解）。我正在寻找 pyomo 的某种文档，比如其他语言的帮助功能，但我还没有找到。例如。我想知道传递给 param() 或 .create-instance 的参数应该具有什么类型和结构。有各种各样的例子，但我无法解释和适应我的情况。

help(pyomo.create_instance())

AttributeError: module 'pyomo' has no attribute 'create_instance'

我的具体问题将在另一篇文章中提出，但总的来说，我正在努力寻找信息。

标签： documentationpyomo

Answer 1

首先，一些有用的资源：

• pyomo 文档：https ://pyomo.readthedocs.io/en/latest/index.html
• pyomo 网站：http ://www.pyomo.org/
• pyomo 论坛：https ://groups.google.com/forum/#!forum/pyomo-forum

最后，在您的 IDE/笔记本中，您仍然可以使用helpand dir，但您必须确保您在实际存在的函数/方法上使用它们，并且您在方法上调用它，而不是在结果上调用它。

根据您收到的消息，pyomo.create_instance不存在。create_instance是 的一个方法pyomo.environ.AbstractModel，所以你应该使用help(pyomo.environ.AbstractModel)（注意没有括号，因为我们没有调用函数/方法）。为了澄清这一点，在 Matlab 中，写作some_function_name和some_function_name(): 该函数无论如何都会被调用（执行）。在 Python 中，some_function_name将函数作为 提供给您object，而some_function_name()实际调用该函数。可以想象，help作用于函数对象，而不是作用于其结果。

作为最后的评论，你真正想从 pyomo 使用的 99% 的东西都位于内部pyomo.environ（除非你想使用更新但不太稳定的kernel库）。我通常做的是开始，from pyomo import environ as pe这样我就可以在不输入pyomo.environ一百万次的情况下获得所需的一切。