search

WU-BIMAC / NBOMicroscopyMetadataSpecs

The 4DN + BINA Tiered System of Microscopy Metadata Guidelines was developed by the 4DN Imaging Standards Working Group in collaboration with the BINA Data Management and Quality Control Working Group (https://www.bioimagingna.org/qc-dm-wg) for documenting microscopy experiments and assessing the quality of image data.
GNU Lesser General Public License v3.0
15 stars 4 forks source link

STRAMBIO/RIGANO -- Model Versioning Proposal #86

Open strambc opened 2 years ago

strambc commented 2 years ago

4DN-BINA-OME model versioning

strambc commented 2 years ago

@andreacosolo @dsudar what do you guys think of this versioning proposal?

andreacosolo commented 2 years ago

While I see what we're trying to achieve here, I continue to have doubts regarding the proposal of a versioning scheme that differs from a standard one, such as semantic versioning. In addition, I think the proposed plan is lacking modularity, which appears to be already a problem (as indicated by the question about extensions, for example) and can only get worse as the overall project grows.

My alternative suggestion would be to:

  1. Clearly separate each project, e.g. the model, each of its extensions, each of its serializations.
  2. Use semantic versioning for each project.
  3. Keep track of dependencies.

For example, you might want to include a file in the serialization project that records its current version, the version of the model it is based on, and the version of any model extension that is relevant. Depending on the project, it could pin one specific version of one particular dependency, or be compatible with a range of versions, or with a range of versions that do not cross a major or minor version boundary.

strambc commented 2 years ago

Just to clarify, the versioning proposal above only would apply to how to handle the Model Version vs. the Version of a given Serialization (e.g., different JSON Schema representation versions of the same Model).