AbstractModule
AbstractModule
AbstractModule Objects
class AbstractModule(Node)
抽象模块，抽象模块为模型的组织提供灵活的管理及扩展能力
__init__
def __init__(name, description)
init(self: ocean.ocean.AbstractModule, name: str, description: str) -> None
构建抽象模型
Parameter name: 名称
Parameter description: 描述
add
def add(child)
add(self: ocean.ocean.AbstractModule, child: ocean.ocean.Node) -> bool
添加子模型
Parameter child: 待添加模型
Returns:
添加是否成功
get
def get(name)
get(self: ocean.ocean.AbstractModule, name: str) -> ocean.ocean.Node
根据名称获取子模型的实例
Parameter name: 名称
Returns:
子模型
getExecutor
@staticmethod
def getExecutor(*args, **kwargs)
getExecutor(self: ocean.ocean.AbstractModule) -> ocean::Executor
获取模型执行器
Returns:
执行器
input
def input(name)
input(self: ocean.ocean.AbstractModule, name: str) -> ocean.ocean.ProxyInput
获取模块的代理输入端口
Parameter name: 端口名称
Returns:
代理端口
loadStatus
@staticmethod
def loadStatus(*args, **kwargs)
loadStatus(self: ocean.ocean.AbstractModule, filePath: str, option: ocean::CompileOption) -> bool
从文件中加载模型参数及状态
Parameter filePath: 文件路径
Parameter option: 模型编译选项
Returns:
加载是否成功
makeInput
def makeInput(name)
makeInput(self: ocean.ocean.AbstractModule, name: str) -> ocean.ocean.ProxyInput
构建代理输入端口，端口自动加入模块中
Parameter name: 端口名称
Returns:
输入端口
makeModel
def makeModel(operation, name='', **kwargs)
makeModel(self: ocean.ocean.AbstractModule, operation: str, name: str = '', **kwargs) -> ocean.ocean.Model
构建基础模型，模型将自动加入模块中
Parameter operation: 操作名称
Parameter args: 参数列表
Parameter name: 实例名称
Returns:
模型
makeModule
def makeModule(constructor, *args, **kwargs)
makeModule(self: ocean.ocean.AbstractModule, constructor: object, *args, **kwargs) -> object
构建内部模块，模块自动加入模块中
Parameter constructor: 模块定义
Parameter args: 参数列表
Returns:
模块指针
makeNeuronGroup
def makeNeuronGroup(operation, name='', **kwargs)
makeNeuronGroup(self: ocean.ocean.AbstractModule, operation: str, name: str = '', **kwargs) -> ocean.ocean.NeuronGroup
构建神经元组模型，模型自动加入模块中
Parameter operation: 操作名称
Parameter name: 实例名称
Parameter args: 参数列表
Returns:
神经元组模型
makeOutput
def makeOutput(name)
makeOutput(self: ocean.ocean.AbstractModule, name: str) -> ocean.ocean.ProxyOutput
构建代理输出端口，端口自动加入模块中
Parameter name: 端口名称
Returns:
输出端口
makeSynapseGroup
def makeSynapseGroup(operation, name='', **kwargs)
makeSynapseGroup(self: ocean.ocean.AbstractModule, operation: str, name: str = '', **kwargs) -> ocean.ocean.SynapseGroup
构建突触组模型，模型自动加入模块中
Parameter name: 实例名称
Parameter operation: 操作名称
Parameter args: 参数列表
Returns:
突触组模型
output
def output(name)
output(self: ocean.ocean.AbstractModule, name: str) -> ocean.ocean.ProxyOutput
获取模块的代理输出端口
Parameter name: 端口名称
Returns:
代理端口
remove
def remove(*args, **kwargs)
remove(*args, **kwargs) Overloaded function.
- remove(self: ocean.ocean.AbstractModule, child: ocean.ocean.Node) -> bool
移除子模型
Parameter child: 子模型
Returns:
移除是否成功
- remove(self: ocean.ocean.AbstractModule, name: str) -> bool
移除子模型
Parameter name: 模型名称
Returns:
移除是否成功
saveProto
def saveProto(filePath)
saveProto(self: ocean.ocean.AbstractModule, filePath: str) -> bool
保存模型描述到Json文件
Parameter filePath: 保存路径
Returns:
是否保存成功
saveStatus
def saveStatus(filePath)
saveStatus(self: ocean.ocean.AbstractModule, filePath: str) -> bool
保存模型结构和参数西信息到二进制文件中
Parameter filePath: 保存路径
Returns:
是否保存成功
size
子模型或模块的数量