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

How to get information / help for pyomo functions, methods etc

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

help(pyomo.create_instance())

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

我将在另一个 post 中提出我的具体问题,但总的来说我很难找到信息。

首先,一些有用的资源:

最后,在你的 IDE/notebook 中,你仍然可以使用 helpdir,但你必须确保你在 functions/methods 上使用它们存在,并且你在方法上调用它,而不是它的结果。

根据您收到的消息,pyomo.create_instance 不存在。 create_instancepyomo.environ.AbstractModel 的一个方法,所以你应该使用 help(pyomo.environ.AbstractModel) (注意没有括号,因为我们没有调用 function/method)。 为了澄清这一点,在 Matlab 中,编写 some_function_namesome_function_name() 之间没有区别:无论如何,函数都是 调用的 (执行)。在 Python 中,some_function_name 将函数作为 object 提供给您,而 some_function_name() 实际上 调用 函数。 可以想象,help 作用于函数 object,而不作用于它的结果。

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

查找方式,我正在寻找的语法是:

help(model.create_instance)