add io module

docs/mod_io.rst

@@ -0,0 +1,140 @@
+IO (Input & Output)
+===================
+
+Reader
+------
+
+Generic Reader
+^^^^^^^^^^^^^^
+
+.. automodule:: rltk.io.reader.reader
+    :members:
+    :special-members:
+    :exclude-members: __dict__, __weakref__, __init__
+
+.. automodule:: rltk.io.reader.array_reader
+    :members:
+    :special-members:
+    :exclude-members: __dict__, __weakref__, __init__
+
+.. automodule:: rltk.io.reader.jsonlines_reader
+    :members:
+    :special-members:
+    :exclude-members: __dict__, __weakref__, __init__
+
+.. automodule:: rltk.io.reader.csv_reader
+    :members:
+    :special-members:
+    :exclude-members: __dict__, __weakref__, __init__
+
+Block Reader
+^^^^^^^^^^^^
+
+.. automodule:: rltk.io.reader.block_reader
+    :members:
+    :special-members:
+    :exclude-members: __dict__, __weakref__, __init__
+
+.. automodule:: rltk.io.reader.block_array_reader
+    :members:
+    :special-members:
+    :exclude-members: __dict__, __weakref__, __init__
+
+.. automodule:: rltk.io.reader.block_file_reader
+    :members:
+    :special-members:
+    :exclude-members: __dict__, __weakref__, __init__
+
+GroundTruth Reader
+^^^^^^^^^^^^^^^^^^
+
+.. automodule:: rltk.io.reader.ground_truth_reader
+    :members:
+    :special-members:
+    :exclude-members: __dict__, __weakref__, __init__
+
+Writer
+------
+
+Generic Writer
+^^^^^^^^^^^^^^
+
+.. automodule:: rltk.io.writer.writer
+    :members:
+    :special-members:
+    :exclude-members: __dict__, __weakref__, __init__
+
+Block Writer
+^^^^^^^^^^^^
+
+.. automodule:: rltk.io.writer.block_writer
+    :members:
+    :special-members:
+    :exclude-members: __dict__, __weakref__, __init__
+
+.. automodule:: rltk.io.writer.block_array_writer
+    :members:
+    :special-members:
+    :exclude-members: __dict__, __weakref__, __init__
+
+.. automodule:: rltk.io.writer.block_file_writer
+    :members:
+    :special-members:
+    :exclude-members: __dict__, __weakref__, __init__
+
+GroundTruth Writer
+^^^^^^^^^^^^^^^^^^
+
+.. automodule:: rltk.io.writer.ground_truth_writer
+    :members:
+    :special-members:
+    :exclude-members: __dict__, __weakref__, __init__
+
+Adapter
+-------
+
+.. automodule:: rltk.io.adapter.key_value_adapter
+    :members:
+    :special-members:
+    :exclude-members: __dict__, __weakref__, __init__
+
+.. automodule:: rltk.io.adapter.memory_adapter
+    :members:
+    :special-members:
+    :exclude-members: __dict__, __weakref__, __init__
+
+.. automodule:: rltk.io.adapter.redis_adapter
+    :members:
+    :special-members:
+    :exclude-members: __dict__, __weakref__, __init__
+
+.. automodule:: rltk.io.adapter.hbase_adapter
+    :members:
+    :special-members:
+    :exclude-members: __dict__, __weakref__, __init__
+
+.. automodule:: rltk.io.adapter.dbm_adapter
+    :members:
+    :special-members:
+    :exclude-members: __dict__, __weakref__, __init__
+
+Serializer
+----------
+
+.. automodule:: rltk.io.serializer.serializer
+    :members:
+    :special-members:
+    :exclude-members: __dict__, __weakref__, __init__
+
+.. automodule:: rltk.io.serializer.pickle_serializer
+    :members:
+    :special-members:
+    :exclude-members: __dict__, __weakref__, __init__
+
+Utilities
+---------
+
+.. automodule:: rltk.io.io_utils
+    :members:
+    :special-members:
+    :exclude-members: __dict__, __weakref__, __init__

docs/modules.rst

@@ -9,6 +9,6 @@ API Reference
    mod_similarity.rst
    mod_evaluation.rst
    mod_blocking.rst
+   mod_io.rst
    mod_parallel_processor.rst
-..   mod_io.rst
 ..   mod_tokenizer.rst