geococo.coco_manager
====================

.. py:module:: geococo.coco_manager


Functions
---------

.. autoapisummary::

   geococo.coco_manager.load_dataset
   geococo.coco_manager.create_dataset
   geococo.coco_manager.save_dataset


Module Contents
---------------

.. py:function:: load_dataset(json_path)

   Dumps the contents of json_path as a string, interprets it as a CocoDataset model
   and returns it.

   :param json_path: path to the JSON file containing the json-encoded COCO dataset
   :return: An instance of CocoDataset with loaded Image- and Annotation objects from
       json_path


.. py:function:: create_dataset(description, contributor, version = str(Version(major=0)), date_created = datetime.now())

   Instances and returns a new CocoDataset model with given kwargs.

   :param description: Description of your COCO dataset
   :param contributor: Main contributors of your COCO dataset, its images and its
       annotations
   :param version: Initial SemVer version (defaults to 0.0.0)
   :param date_created: Date when dataset was initially created, defaults to
       datetime.now()
   :return: An instance of CocoDataset without Image- and Annotation objects


.. py:function:: save_dataset(dataset, json_path)

   JSON-encodes an instance of CocoDataset and saves it to json_path.

   :param dataset: An instance of CocoDataset
   :param json_path: where to save the JSON-encoded CocoDataset instance to