:py:mod:`kwcoco.coco_schema`
============================

.. py:module:: kwcoco.coco_schema

.. autoapi-nested-parse::

   .. rubric:: CommandLine

   .. code-block:: bash

       python -m kwcoco.coco_schema
       xdoctest -m kwcoco.coco_schema __doc__

   .. rubric:: Example

   >>> import kwcoco
   >>> from kwcoco.coco_schema import COCO_SCHEMA
   >>> import jsonschema
   >>> dset = kwcoco.CocoDataset.demo('shapes1')
   >>> # print('dset.dataset = {}'.format(ub.repr2(dset.dataset, nl=2)))
   >>> COCO_SCHEMA.validate(dset.dataset)

   >>> try:
   >>>     jsonschema.validate(dset.dataset, schema=COCO_SCHEMA)
   >>> except jsonschema.exceptions.ValidationError as ex:
   >>>     vali_ex = ex
   >>>     print('ex = {!r}'.format(ex))
   >>>     raise
   >>> except jsonschema.exceptions.SchemaError as ex:
   >>>     print('ex = {!r}'.format(ex))
   >>>     schema_ex = ex
   >>>     print('schema_ex.instance = {}'.format(ub.repr2(schema_ex.instance, nl=-1)))
   >>>     raise

   >>> # Test the multispectral image defintino
   >>> import copy
   >>> dataset = dset.copy().dataset
   >>> img = dataset['images'][0]
   >>> img.pop('file_name')
   >>> import pytest
   >>> with pytest.raises(jsonschema.ValidationError):
   >>>     COCO_SCHEMA.validate(dataset)
   >>> import pytest
   >>> img['auxiliary'] = [{'file_name': 'foobar'}]
   >>> with pytest.raises(jsonschema.ValidationError):
   >>>     COCO_SCHEMA.validate(dataset)
   >>> img['name'] = 'aux-only images must have a name'
   >>> COCO_SCHEMA.validate(dataset)



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


Functions
~~~~~~~~~

.. autoapisummary::

   kwcoco.coco_schema.deprecated
   kwcoco.coco_schema.TUPLE



Attributes
~~~~~~~~~~

.. autoapisummary::

   kwcoco.coco_schema.elem
   kwcoco.coco_schema.ALLOF
   kwcoco.coco_schema.ANY
   kwcoco.coco_schema.ANYOF
   kwcoco.coco_schema.ARRAY
   kwcoco.coco_schema.BOOLEAN
   kwcoco.coco_schema.INTEGER
   kwcoco.coco_schema.NOT
   kwcoco.coco_schema.NULL
   kwcoco.coco_schema.NUMBER
   kwcoco.coco_schema.OBJECT
   kwcoco.coco_schema.ONEOF
   kwcoco.coco_schema.STRING
   kwcoco.coco_schema.UUID
   kwcoco.coco_schema.PATH
   kwcoco.coco_schema.KWCOCO_KEYPOINT
   kwcoco.coco_schema.KWCOCO_POLYGON
   kwcoco.coco_schema.ORIG_COCO_KEYPOINTS
   kwcoco.coco_schema.KWCOCO_KEYPOINTS
   kwcoco.coco_schema.KEYPOINTS
   kwcoco.coco_schema.ORIG_COCO_POLYGON
   kwcoco.coco_schema.POLYGON
   kwcoco.coco_schema.RUN_LENGTH_ENCODING
   kwcoco.coco_schema.BBOX
   kwcoco.coco_schema.SEGMENTATION
   kwcoco.coco_schema.CATEGORY
   kwcoco.coco_schema.KEYPOINT_CATEGORY
   kwcoco.coco_schema.VIDEO
   kwcoco.coco_schema.CHANNELS
   kwcoco.coco_schema.IMAGE
   kwcoco.coco_schema.ANNOTATION
   kwcoco.coco_schema.COCO_SCHEMA


.. py:function:: deprecated(*args)


.. py:function:: TUPLE(*args, **kw)


.. py:data:: elem
   

   

.. py:data:: ALLOF
   

   

.. py:data:: ANY
   

   

.. py:data:: ANYOF
   

   

.. py:data:: ARRAY
   

   

.. py:data:: BOOLEAN
   

   

.. py:data:: INTEGER
   

   

.. py:data:: NOT
   

   

.. py:data:: NULL
   

   

.. py:data:: NUMBER
   

   

.. py:data:: OBJECT
   

   

.. py:data:: ONEOF
   

   

.. py:data:: STRING
   

   

.. py:data:: UUID
   

   

.. py:data:: PATH
   

   

.. py:data:: KWCOCO_KEYPOINT
   

   

.. py:data:: KWCOCO_POLYGON
   

   

.. py:data:: ORIG_COCO_KEYPOINTS
   

   

.. py:data:: KWCOCO_KEYPOINTS
   

   

.. py:data:: KEYPOINTS
   

   

.. py:data:: ORIG_COCO_POLYGON
   

   

.. py:data:: POLYGON
   

   

.. py:data:: RUN_LENGTH_ENCODING
   

   

.. py:data:: BBOX
   

   

.. py:data:: SEGMENTATION
   

   

.. py:data:: CATEGORY
   

   

.. py:data:: KEYPOINT_CATEGORY
   

   

.. py:data:: VIDEO
   

   

.. py:data:: CHANNELS
   

   

.. py:data:: IMAGE
   

   

.. py:data:: ANNOTATION
   

   

.. py:data:: COCO_SCHEMA