Merge pull request #83 from stac-extensions/fix-md-lint-format

adjust remark config to aligh `check-markdown` with `format-markdown` outputs

Author: fmigneault

.github/remark.yaml

@@ -1,3 +1,11 @@
+settings:
+  listItemIndent: '1'
+  emphasis: '*'
+  spacedTable: false
+  paddedTable: true
+  stringify:
+    entities: false
+    escape: false
 plugins:
 # Check links
   - validate-links
@@ -14,8 +22,11 @@ plugins:
   - remark-lint-no-consecutive-blank-lines
   - - remark-lint-maximum-line-length
     - 120
+  - remark-lint-no-literal-urls
 # GFM - autolink literals, footnotes, strikethrough, tables, tasklist
   - remark-gfm
+# Math Expression
+  - remark-math
 # Code
   - remark-lint-fenced-code-flag
   - remark-lint-fenced-code-marker
@@ -33,14 +44,17 @@ plugins:
   - - remark-lint-no-shortcut-reference-link
     - false
 # Lists
-  - remark-lint-list-item-bullet-indent
+  - - remark-lint-list-item-bullet-indent
+    - 'one'
   - remark-lint-ordered-list-marker-style
   - remark-lint-ordered-list-marker-value
   - remark-lint-checkbox-character-style
   - - remark-lint-unordered-list-marker-style
     - '-'
+  - - remark-lint-list-item-content-indent
+    - 1
   - - remark-lint-list-item-indent
-    - space
+    - 'space'
 # Tables
   - remark-lint-table-pipes
-  - remark-lint-no-literal-urls
+  - remark-lint-table-cell-padding

CHANGELOG.md

@@ -8,29 +8,35 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased](https://github.com/stac-extensions/mlm/tree/main)
 
 ### Added
+
 - Add [`huggingface/safetensors`](https://github.com/huggingface/safetensors)
-  recommendations for `mlm:artifact_type` and corresponding ``mlm:framework`` values
+  recommendations for `mlm:artifact_type` and corresponding `mlm:framework` values
   (fixes [#68](https://github.com/stac-extensions/mlm/issues/68)).
 - Add [`Flax`](https://github.com/google/flax) to the list of `mlm:framework` and
   the corresponding `mlm:artifact_type` SafeTensors backend in the JSON schema examples.
 - Add [`Paddle`](https://github.com/PaddlePaddle/Paddle) to the list of `mlm:framework`
   (fixes [#69](https://github.com/stac-extensions/mlm/issues/69)).
 
 ### Changed
+
 - Update `stac-model==0.3.0` to provide `ValueScalingObject` from installed package.
 
 ### Deprecated
+
 - n/a
 
 ### Removed
+
 - n/a
 
 ### Fixed
+
 - n/a
 
 ## [v1.4.0](https://github.com/stac-extensions/mlm/tree/v1.4.0)
 
 ### Added
+
 - Add better descriptions about required and recommended *MLM Asset Roles* and
   their implications (fixes
   [#54](https://github.com/stac-extensions/mlm/issues/54)).
@@ -44,6 +50,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   for Ahead of Time Compilation, `jit` for Just-In Time Compilation.
 
 ### Changed
+
 - Explicitly disallow `mlm:name`, `mlm:input`, `mlm:output` and `mlm:hyperparameters` at the Asset level.
   These fields describe the model as a whole and should therefore be defined in Item properties.
 - Moved `norm_type` to `value_scaling` object to better reflect the expected operation, which could be another
@@ -54,9 +61,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - expanded suggested `mlm:artifact_type` values to include Tensorflow/Keras.
 
 ### Deprecated
+
 - n/a
 
 ### Removed
+
 - Removed `norm_type` enum values that were ambiguous regarding their expected result.
   Instead, a `processing:expression` should be employed to explicitly define the calculation they represent.
 - Removed `norm_clip` property. It is now represented under `value_scaling` objects with a
@@ -66,6 +75,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   Otherwise, the amount of `value_scaling` objects should match the number of bands or channels involved in the input.
 
 ### Fixed
+
 - Fix missing `mlm:artifact_type` property check for a Model Asset definition
   (fixes <https://github.com/stac-extensions/mlm/issues/42>).
   The `mlm:artifact_type` is now mutually and exclusively required by the corresponding Asset with `mlm:model` role.
@@ -75,27 +85,32 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [v1.3.0](https://github.com/stac-extensions/mlm/tree/v1.3.0)
 
 ### Added
+
 - Add `raster:bands` required property `name` for describing `mlm:input` bands
   (see [README - Bands and Statistics](README.md#bands-and-statistics) for details).
 - Add README warnings about new extension `eo` and `raster` versions.
 
 ### Changed
+
 - Split `ModelBands` and `AnyBandsRef` definitions in the JSON schema to allow them to be referenced individually.
 - Move `AnyBandsRef` definition explicitly to STAC Item JSON schema, rather than implicitly inferred via `mlm:input`.
 - Modified the JSON schema to use a `if` check of the `type` (STAC Item or Collection) prior to validating further
   properties. This allows some validators (e.g. `pystac`) to better report the *real* error that causes the schema
   to fail, rather than reporting the first mismatching `type` case with a poor error description to debug the issue.
 
 ### Deprecated
+
 - n/a
 
 ### Removed
+
 - Removed `$comment` entries from the JSON schema that are considered as invalid by some parsers.
 - When `mlm:input` objects do **NOT** define band references (i.e.: `bands: []` is used), the JSON schema will not
   fail if an Asset with the `mlm:model` role contains a band definition. This is to allow MLM model definitions to
   simultaneously use some inputs with `bands` reference names while others do not.
 
 ### Fixed
+
 - Band checks against [`eo`](https://github.com/stac-extensions/eo), [`raster`](https://github.com/stac-extensions/eo)
   or STAC Core 1.1 [`bands`](https://github.com/radiantearth/stac-spec/blob/master/commons/common-metadata.md#bands)
   when a `mlm:input` references names in `bands` are now properly validated.
@@ -110,47 +125,57 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [v1.2.0](https://github.com/stac-extensions/mlm/tree/v1.2.0)
 
 ### Added
+
 - Add the missing JSON schema `item_assets` definition under a Collection to ensure compatibility with
   the [Item Assets](https://github.com/stac-extensions/item-assets) extension, as mentioned this specification.
 - Add `ModelBand` representation using `name`, `format` and `expression` properties to allow derived band references
   (fixes [crim-ca/mlm-extension#7](https://github.com/stac-extensions/mlm/discussions/7)).
 
 ### Changed
+
 - Adds a job to `.github/workflows/publish.yaml` to publish the `stac-model` package to PyPI.
 
 ### Deprecated
+
 - n/a
 
 ### Removed
+
 - Field `mlm:name` requirement to be unique. There is no way to guarantee this from a single Item's definition
   and their JSON schema validation. For uniqueness requirement, users should instead rely on the `id` property
   of the Item, which is ensured to be unique under the corresponding Collection, since it would not be retrievable
   otherwise (i.e.: `collections/{collectionID}/items/{itemID}`).
 
 ### Fixed
+
 - Fix the validation strategy of the `mlm:model` role required by at least one Asset under a STAC Item.
   Although the role requirement was validated, the definition did not allow for other Assets without it to exist.
 - Correct `stac-model` version in code and publish matching release on PyPI.
 
 ## [v1.1.0](https://github.com/stac-extensions/mlm/tree/v1.1.0)
 
 ### Added
+
 - Add pattern for `mlm:framework`, needing at least one alphanumeric character,
   without leading or trailing non-alphanumeric characters.
 - Add [`examples/item_eo_and_raster_bands.json`](examples/item_eo_and_raster_bands.json) demonstrating the original
   use case represented by the previous [`examples/item_eo_bands.json`](examples/item_eo_bands.json) contents.
 - Add a `description` field for `mlm:input` and `mlm:output` definitions.
 
 ### Changed
+
 - Adjust `scikit-learn` and `Hugging Face` framework names to match the format employed by the official documentation.
 
 ### Deprecated
+
 - n/a
 
 ### Removed
+
 - Removed combination of `mlm:input` with `bands: null` that could never occur due to pre-requirement of `type: array`.
 
 ### Fixed
+
 - Fix `AnyBands` definition and use in the JSON schema to better consider possible use cases with `eo` extension.
 - Fix [`examples/item_eo_bands.json`](examples/item_eo_bands.json) that was incorrectly also using `raster` extension.
   This is not fundamentally wrong, but it did not allow to validate the `eo` extension use case properly, since
@@ -159,6 +184,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [v1.0.0](https://github.com/stac-extensions/mlm/tree/v1.0.0)
 
 ### Added
+
 - more [Task Enum](README.md#task-enum) tasks
 - [Model Output Object](README.md#model-output-object)
 - `batch_size` and hardware summary
@@ -172,6 +198,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   pixel-wise and patch-based classification
 
 ### Changed
+
 - `disk_size` replaced by `file:size` (see [Best Practices - File Extension](best-practices.md#file-extension))
 - `memory_size` under `dlm:architecture` moved directly under Item properties as `mlm:memory_size`
 - replaced all hardware/accelerator/runtime definitions into distinct `mlm` fields directly under the
@@ -191,23 +218,28 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - updated JSON schema to reflect changes of MLM fields
 
 ### Deprecated
+
 - any `dlm`-prefixed field or property
 
 ### Removed
+
 - Data Object, replaced with [Model Input Object](./README.md#model-input-object) that uses the `name` field from
   the [common metadata band object][stac-bands] which also records `data_type` and `nodata` type
 
 ### Fixed
+
 - n/a
 
 [stac-bands]: https://github.com/radiantearth/stac-spec/blob/f9b3c59ba810541c9da70c5f8d39635f8cba7bcd/item-spec/common-metadata.md#bands
 
 ## [v1.0.0-beta3](https://github.com/crim-ca/dlm-extension/tree/v1.0.0-beta3)
 
 ### Added
+
 - Added example model architecture summary text.
 
 ### Changed
+
 - Modified `$id` if the extension schema to refer to the expected location when eventually released
   (`https://schemas.stacspec.org/v1.0.0-beta.3/extensions/dl-model/json-schema/schema.json`).
 - Replaced `dtype` field by `data_type` to better align with the corresponding field of
@@ -223,33 +255,41 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [raster-band-object]: https://github.com/stac-extensions/raster/#raster-band-object
 
 ### Deprecated
+
 - Specifying `class_name_mapping` by array is deprecated.
   Direct mapping as an object of index to class name should be used.
   For backward compatibility, mapping as array and using nested objects with `index` and `class_name` properties
   is still permitted, although overly verbose compared to the direct mapping.
 
 ### Removed
+
 - Field `nodata_value`.
 - Field `dtype`.
 
 ### Fixed
+
 - Fixed references to other STAC extensions to use the official schema links on `https://stac-extensions.github.io/`.
 - Fixed examples to refer to local files.
 - Fixed formatting of tables and descriptions in README.
 
 ## [v1.0.0-beta2](https://github.com/crim-ca/dlm-extension/tree/v1.0.0-beta2)
 
 ### Added
+
 - Initial release of the extension description and schema.
 
 ### Changed
+
 - n/a
 
 ### Deprecated
+
 - n/a
 
 ### Removed
+
 - n/a
 
 ### Fixed
+
 - n/a