/*
* BSD 3-Clause License
*
* Copyright (c) 2017, Shogun-Toolbox e.V. <shogun-team@shogun-toolbox.org>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice, this
*   list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright notice,
*   this list of conditions and the following disclaimer in the documentation
*   and/or other materials provided with the distribution.
*
* * Neither the name of the copyright holder nor the names of its
*   contributors may be used to endorse or promote products derived from
*   this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* Written (W) 2017 Giovanni De Toni
*
*/
#include <shogun/lib/config.h>
#ifdef HAVE_TFLOGGER

#ifndef SHOGUN_OUTPUTFORMAT_H
#define SHOGUN_OUTPUTFORMAT_H

#include <shogun/base/SGObject.h>
#include <shogun/lib/any.h>
#include <shogun/lib/parameter_observers/ObservedValue.h>
#include <tflogger/event.pb.h>

#include <utility>

namespace shogun
{
	/**
	 * Convert an std::pair<std::string, Any> to a tensorflow::Event,
	 * which can be written to file and used with tools like Tensorboard.
	 */
	class TBOutputFormat : public CSGObject
	{

	public:
		TBOutputFormat();
		~TBOutputFormat();

		/**
		 * Generate a tensorflow::Event object give some informations
		 * @param event_step the current event step
		 * @param value the value which will be converted to tensorflow::Event
		 * @param node_name the node name (default: node)
		 * @return the newly created tensorflow::Event
		 */
		tensorflow::Event
		convert_scalar(const TimedObservedValue& value, std::string& node_name);

		tensorflow::Event
		convert_vector(const TimedObservedValue& value, std::string& node_name);

		virtual const char* get_name() const
		{
			return "TFLogger";
		}
	};
}

#endif // SHOGUN_OUTPUTFORMAT_H
#endif // HAVE_TFLOGGER
