Merge pull request #132 from JamieMair/fix-serialisation-bug

Fix serialisation bug

Author: nomadbl

Project.toml

@@ -1,7 +1,7 @@
 name = "TensorBoardLogger"
 uuid = "899adc3e-224a-11e9-021f-63837185c80f"
 authors = ["Filippo Vicentini <[email protected]>"]
-version = "0.1.21"
+version = "0.1.22"
 
 [deps]
 CRC32c = "8bf52ea8-c179-5cab-976a-9e18b702a9bc"

src/event.jl

@@ -29,17 +29,16 @@ format. The format follows the following rule (in bytes)
 #4 N..N+8      UInt32  masked_CRC of #3
 """
 function write_event(out::IO, event::Event)
-    data = PipeBuffer();
-    encode(ProtoEncoder(data), event)
+    event_bytes = serialize_proto(event)
 
     #header
-    header     = collect(reinterpret(UInt8, [data.size]))
+    header     = collect(reinterpret(UInt8, [length(event_bytes)]))
     crc_header = reinterpret(UInt8, UInt32[masked_crc32c(header)])
-    crc_data   = reinterpret(UInt8, UInt32[masked_crc32c(data.data)])
+    crc_data   = reinterpret(UInt8, UInt32[masked_crc32c(event_bytes)])
 
     write(out, header)
     write(out, crc_header)
-    write(out, data.data)
+    write(out, event_bytes)
     write(out, crc_data)
     flush(out)
 end

src/hparams.jl

@@ -73,12 +73,6 @@ function metric_info(c::MetricConfig)
     return HP.MetricInfo(mname, c.displayname, c.description, HDatasetType.DATASET_UNKNOWN)
 end
 
-function encode_bytes(content::HP.HParamsPluginData)
-    data = PipeBuffer()
-    encode(ProtoEncoder(data), content)
-    return take!(data)
-end
-
 # Dictionary serialisation in ProtoBuf does not work for this specific map type
 # and must be overloaded so that it can be parsed. The format was derived by
 # looking at the binary output of a log file created by tensorboardX.
@@ -156,17 +150,17 @@ function write_hparams!(logger::TBLogger, hparams::Dict{String,<:Any}, metrics::
 
     experiment = HP.Experiment("", "", "", time(), hparam_infos, metric_infos)
     experiment_content = HP.HParamsPluginData(PLUGIN_DATA_VERSION, OneOf(:experiment, experiment))
-    experiment_md = SummaryMetadata(SummaryMetadata_PluginData(PLUGIN_NAME, encode_bytes(experiment_content)), "", "", DataClass.DATA_CLASS_UNKNOWN)
+    experiment_md = SummaryMetadata(SummaryMetadata_PluginData(PLUGIN_NAME, serialize_proto(experiment_content)), "", "", DataClass.DATA_CLASS_UNKNOWN)
     experiment_summary = Summary([Summary_Value("", EXPERIMENT_TAG, experiment_md, nothing)])
 
     session_start_info = HP.SessionStartInfo(hparams_dict, "", "", "", time())
     session_start_content = HP.HParamsPluginData(PLUGIN_DATA_VERSION, OneOf(:session_start_info, session_start_info))
-    session_start_md = SummaryMetadata(SummaryMetadata_PluginData(PLUGIN_NAME, encode_bytes(session_start_content)), "", "", DataClass.DATA_CLASS_UNKNOWN)
+    session_start_md = SummaryMetadata(SummaryMetadata_PluginData(PLUGIN_NAME, serialize_proto(session_start_content)), "", "", DataClass.DATA_CLASS_UNKNOWN)
     session_start_summary = Summary([Summary_Value("", SESSION_START_INFO_TAG, session_start_md, nothing)])
 
     session_end_info = HP.SessionEndInfo(HP.Status.STATUS_SUCCESS, time())
     session_end_content = HP.HParamsPluginData(PLUGIN_DATA_VERSION, OneOf(:session_end_info, session_end_info))
-    session_end_md = SummaryMetadata(SummaryMetadata_PluginData(PLUGIN_NAME, encode_bytes(session_end_content)), "", "", DataClass.DATA_CLASS_UNKNOWN)
+    session_end_md = SummaryMetadata(SummaryMetadata_PluginData(PLUGIN_NAME, serialize_proto(session_end_content)), "", "", DataClass.DATA_CLASS_UNKNOWN)
     session_end_summary = Summary([Summary_Value("", SESSION_END_INFO_TAG, session_end_md, nothing)])
 
     for s in (experiment_summary, session_start_summary, session_end_summary)

src/utils.jl

@@ -9,7 +9,7 @@ end
 function serialize_proto(data)
     pb = PipeBuffer()
     encode(ProtoEncoder(pb), data)
-    pb.data
+    return take!(pb) # Do not return additional zeros
 end
 
 """

test/test_hparams.jl

@@ -65,7 +65,7 @@ const hparams_metadata_encoded_bytes = UInt8[0x1a, 0x5b, 0x0a, 0x0e, 0x0a, 0x06,
     session_start_info = TensorBoardLogger.HP.SessionStartInfo(hparams_dict, "", "", "", zero(Float64))
     session_start_content = TensorBoardLogger.HP.HParamsPluginData(PLUGIN_DATA_VERSION, TensorBoardLogger.OneOf(:session_start_info, session_start_info))
 
-    @test TensorBoardLogger.encode_bytes(session_start_content) == hparams_metadata_encoded_bytes
+    @test TensorBoardLogger.serialize_proto(session_start_content) == hparams_metadata_encoded_bytes
 end