Skip to content

Latest commit

 

History

History
99 lines (64 loc) · 5.88 KB

CHANGELOG.md

File metadata and controls

99 lines (64 loc) · 5.88 KB
Raw

Change Log

All notable changes to this project are documented in this file.

The format is loosely based on Keep a Changelog. Loosely because we do not keep separate sections within a version for additions and fixes etcetera, instead most logged changes will start with one of Added, Changed, Deprecated, Removed, Fixed, or Security. This project follows Semantic Versioning, but until we hit version 1.0.0 we will be somewhat cavalier in our versioning.

This file documents changes made to the MMIF specification. Version names used to start with spec- because the Python MMIF SDK was also maintained in this repository. Starting with version 0.2.2 the repository was split and the prefix was discarded.

Version 1.0.5 - 2023-06-25

  • Fixed typo in a sample MMIF file

Version 1.0.4 - 2023-03-16

  • Added optional field mmif.view.metadata.appConfiguration to store configuration map actually used by the app (refined from user input and defaults).

Version 1.0.3 - 2024-03-16

  • Fixed typo in classification property name (was classifications plural).

Version 1.0.2 - 2024-02-28

  • Added general properties (label, labelset, and classification) for recording classification results (#218).

Version 1.0.1 - 2024-02-07

  • vocabulary types now have similarTo field to link similar type definitions as URI (#203).
  • updated TimeFrame definition to ease frameType value restrictions (#207).

Version 1.0.0 - 2023-05-26

  • Re-release of 0.5.0 (our last release candidate) as 1.0.0 stable version.

Version 0.5.0 - 2023-04-21

  • Changed IRI format of CLAMS vocabulary items
    • old format: https://mmif.clams.ai/<VERSION>/vocabulary/<TYPE_NAME>
    • new format: https://mmif.clams.ai/vocabulary/<TYPE_NAME>/<VERSION>
  • CLAMS vocabulary items are now versioned independently of the MMIF version. See comments time-stamped between Feb 2023 - Apr 2023 in these threads for discussion behind this big change:
  • Some of required fields in MMIF must now have non-empty values (see #196).

Version 0.4.2 - 2023-02-09

  • Added warnings field in view metadata. This can be used to throw runtime warnings (in other words, non-critical errors). Currently, we decided for an app to create a new empty view AFTER all of its processed views and collect all warnings there. (see #188).
  • Re-purposed top-level Annotation @type for document-level metadata annotations. It was previously just an abstract placeholder in the type hierarchy.

Version 0.4.1 − 2022-11-17

  • Cosmetic changes and documentation updates.

Version 0.4.0 − 2021-06-09

  • Removed all optional attributes from annotationProperties in the JSON schema. We figured that it is impossible to keep all attributes from all individual vocabulary types in a single JSON schema file (e.g. no way to deal with naming conflicts).
  • Renamed Region.unit to Region.timeUnit. We realized that only time needs a unit to measure. Image regions are always based on pixels and text regions are always on unicode codepoints (not bytes).
  • Renamed TimePoint.point to TimePoint.timePoint to make it more consistent with Polygon.timePoint.
  • Added sourceType and targetType as metadata props to Alignment type, to simplify navigation over simple bi-modal aliangments.

Version 0.3.1 − 2021-05-11

  • Added and error property to the view metadata. The view metadata now either have an non-empty error section or a non-empty contains section. This is not a breaking change since the old schema did allow arbitrary extra properties in the view metadata.
  • Replaced hard-coded version numbers with a variable. The build script uses templating to deal with them.
  • Changed the old script vocabulary/publish to make it more general, it was also moved to build.py.

Version 0.3.0 − 2021-03-10

  • Updated the MMIF schema. Most significant change is that the location property is now a URI. This is likely a breaking change for all applications that work with version 0.2.2, hence the minor version bump up.
  • Added boxType property to BoundingBox.

Version 0.2.2 − 2020-12-03

Version spec-0.2.1 − 2020-09-28

  • Removed the @contexts and the mediumMetadata from the MMIF context. This would usually not be a patch-level change but for just this occasion we decided it was.
  • Fixed a variety of spelling errors in the sample MMIF documents and specifications.

Version spec-0.2.0 − 2020-09-11

  • Added document types to the vocabulary, this included adding a new top type.
  • Changed the Annotation type by adding document as a metadata property and a regular property.
  • Changed the Alignment type by making it parent the top type.
  • Removed the context property from the top-level in the MMIF file and from the views.
  • Removed the contexts files from the published specifications.
  • Changed the media property on the MMIF files into the documents property.
  • Made the documents list property read only. If new primary data are created then they will be put in a new view as a document.
  • Fixed issue #75 (we are now using app instead of tool in the view metadata).
  • Changed the JSON schema to fit the new syntax of MMIF.
  • Changed the informal specifications to reflect all the above changes.
  • Added full MMIF samples to the specifications.

Version 0.1.0 − 2020-07-23

First released version.