Caffe2 - Python API
A deep learning, cross platform ML framework
Public Member Functions | List of all members
caffe2.python.dataio.Writer Class Reference
Inheritance diagram for caffe2.python.dataio.Writer:
caffe2.python.dataset._DatasetWriter caffe2.python.queue_util._QueueWriter caffe2.python.record_queue._QueueWriter

Public Member Functions

def schema (self)
 
def write (self, writer_net, fields)
 
def write_record (self, writer_net, fields)
 
def setup_ex (self, init_net, finish_net)
 
def write_ex (self, fields, local_init_net, local_finish_net, stop_blob)
 
def write_record_ex (self, fields, local_init_net, local_finish_net, stop_blob=None)
 
def commit (self, finish_net)
 

Detailed Description

Writer is an abstract class to be implemented in order to provide
operations capable of feeding a data stream or a dataset.

A Writer must implement 2 operations:
`write`, which adds operations to a net that write the write batch of
data, and `commit`, which adds operations to a net in order to indicate
that no more data will be written.

Definition at line 160 of file dataio.py.

Member Function Documentation

def caffe2.python.dataio.Writer.commit (   self,
  finish_net 
)
Add operations to `finish_net` that signal end of data.

This must be implemented by all Writers, but may be no-op for some
of them.

Definition at line 215 of file dataio.py.

def caffe2.python.dataio.Writer.setup_ex (   self,
  init_net,
  finish_net 
)
Experimental, don't use yet

Definition at line 193 of file dataio.py.

def caffe2.python.dataio.Writer.write (   self,
  writer_net,
  fields 
)
Add operations to `writer_net` that write the next batch of data.

Operations added to the net must be thread-safe and unique, that is:
multiple writers must be able to write to the dataset in parallel.

Args:
    fields: a tuple of BlobReference containing the batch of data to
    write.

Definition at line 175 of file dataio.py.

def caffe2.python.dataio.Writer.write_ex (   self,
  fields,
  local_init_net,
  local_finish_net,
  stop_blob 
)
Experimental extension to the interface. Don't use yet

Definition at line 197 of file dataio.py.

def caffe2.python.dataio.Writer.write_record_ex (   self,
  fields,
  local_init_net,
  local_finish_net,
  stop_blob = None 
)
Experimental extension to the interface. Don't use yet.

Definition at line 204 of file dataio.py.


The documentation for this class was generated from the following file: