Caffe2 - (五)Workspace Python API

Caffe2 - Workspace Python API

Module caffe2.python.workspace.

Demo：

from caffe2.proto.caffe2_pb2 import NetDef
from caffe2.python import workspace

init_net = NetDef()
init_net.ParseFromString(open(protobuf_data))
predict_net = NetDef()
predict_net.ParseFromString(open(protobuf_data))
print predict_net.name //would reveal the name field

workspace.CreateNet(init_net)
workspace.CreateNet(predict_net)
workspace.RunNet(predict_net)

1. CreateNet()

定义：

def workspace.CreateNet(net_def, input_blobs):

如果未给定输入 blobs，则创建空的 net.

2. FeedBlob()

定义：

def workspace.FeedBlob(name, arr, device_option=None): 

将 blob 送入(Feed into) workspace.

• 输入： name：blob name arr：TensorProto object 或 numpy array object device_option：数据送入 workspace 的 device 选项
• 输出： 返回值是 True 或 False，表示是否成功将 blob 送入 workspace.

3. FetchBlob()

定义：

def FetchBlob(name):

从 workspace 中拉取 blob.

• 输入： name：blob name，一般为字符串形式.
• 输出： 如果拉取成功，返回值是 array 或 string.

4. FetchBlobs()

定义：

def FetchBlobs(names):

从 workspace 中拉取多个 blobs 列表.

• 输入： names：blobs names，一般是字符串形式.
• 输出： 拉取的 blobs 列表.

5. GetNameScope()

定义：

def GetNameScope():

返回当前 namescope 字符串，用于拉取 blobs.

6. InferShapesAndTypes()

定义：

def InferShapesAndTypes(nets, blob_dimensions=None):

判断特定 nets 的 shapes 和 types(类型).

• 输入： nets：nets list blob_dimensions：由 blobs 和其 dimensions 组成的字典. 默认是，workspace blobs.
• 输出： 返回根据 blob name 键值的 (shapes，types) 字典的元组.

7. RunNet()

定义：

def RunNet(name, num_iter=1, allow_fail=False):

运行给定 net.

• 输入： name： net 名，或 net reference. num_iter：运行的迭代次数 allow_fail：if True, does not assert on net exec failure but returns False
• 输出： 返回 True 或 exception.

8. RunNetOnce

定义：

def workspace.RunNetOnce(net):

训练 net 一次.

9. RunOperatorOnce

定义：

def workspace.RunOperatorOnce(operator):

执行单个 operator.

10. RunOperatorsOnce

定义：

def workspace.RunOperatorOnce(operators):

执行多个 operators.

11. RunPlan

定义：

def workspace.RunPlan(plan_or_step):

构建多个执行步骤计划，以运行多个不同的网络.

12. StartMint()

定义：

def StartMint(root_folder=None, port=None):

启动 Mint 实例.

13. StopImmediate()

定义：

def StopImmediate():

停止即时模式运行. Stops an immediate mode run.

14. StringifyProto()

定义：

def StringifyProto(obj):

协议缓冲区对象(protocol buffer object)字符串化.

• 输入： obj：protocol buffer object，或包含一个 Proto() 函数的 Pycaffe2 object.
• 输出： 返回 String：output protobuf string.
• Raises: AttributeError: if the passed in object does not have the right attribute.

15. StringifyBlobName

定义：

def workspace.StringifyBlobName(name):

返回 blob name.

16. StringifyNetName

定义：

def workspace.StringifyNetName(name):

返回 net name.

Reference

[1] - Workspace Class

[2] - workspace.py