Merge pull request #32 from stac-extensions/add-citation

.github/workflows/citation.yaml

@@ -0,0 +1,17 @@
+name: Check Citation Format
+on:
+  push:
+    paths:
+      - CITATION.cff
+  pull_request:
+    paths:
+      - CITATION.cff
+jobs:
+  check-citation:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Check whether the citation metadata from CITATION.cff is valid
+        uses: citation-file-format/cffconvert-github-action@2.0.0
+        with:
+          args: "--validate"

CITATION.cff

@@ -0,0 +1,263 @@
+cff-version: 1.2.0
+message: If you use this standard or software, please cite it using the metadata from this file.
+title: Machine Learning Model Extension Specification for SpatioTemporal Asset Catalog
+type: software
+keywords:
+  - mlm
+  - Machine Learning
+  - Model
+  - STAC
+url: "https://github.com/stac-extensions/mlm/blob/main/README.md"
+repository-code: "https://github.com/stac-extensions/mlm"
+license: Apache-2.0
+license-url: https://github.com/stac-extensions/mlm/blob/main/LICENSE
+identifiers:
+  - type: doi
+    value: "10.1145/3681769.3698586"
+    description: "Conference paper presenting the standard."
+  - type: url
+    value: "https://stac-extensions.github.io/mlm/"
+    description: "Generic URL of the MLM extension schema versions for 'stac_extensions' references."
+contact:
+  - given-names: Francis
+    family-names: Charette-Migneault
+    email: francis.charette-migneault@crim.ca
+    affiliation: Computer Research Institute of Montréal (CRIM)
+    orcid: "https://orcid.org/0000-0003-4862-3349"
+  - given-names: Ryan
+    family-names: Avery
+    alias: rbavery
+    email: ryan@wherobots.com
+    affiliation: "Wherobots, Inc."
+    orcid: "https://orcid.org/0000-0001-7392-1474"
+authors: &authors
+  - given-names: Francis
+    family-names: Charette-Migneault
+    alias: fmigneault
+    email: francis.charette-migneault@crim.ca
+    affiliation: Computer Research Institute of Montréal (CRIM)
+    orcid: "https://orcid.org/0000-0003-4862-3349"
+  - given-names: Ryan
+    family-names: Avery
+    alias: rbavery
+    email: ryan@wherobots.com
+    affiliation: "Wherobots, Inc."
+    orcid: "https://orcid.org/0000-0001-7392-1474"
+  - name: Computer Research Institute of Montréal
+    city: Montréal
+    region: Québec
+    alias: CRIM
+    website: "https://www.crim.ca/"
+    email: info@crim.ca
+    tel: 1 (514) 840-1234
+    country: CA
+    post-code: H3N 1M3
+    address: "101 – 405, avenue Ogilvy"
+  - name: "Wherobots, Inc."
+    address: 350 California St
+    city: San Francisco
+    country: US
+    post-code: "94104"
+    region: California
+    website: "https://www.wherobots.ai/"
+    location: Floor 1 - Lincoln Towne Center
+
+references:
+  - type: software-code
+    title: "A PydanticV2 and PySTAC validation and serialization library for the STAC ML Model Extension"
+    keywords:
+      - stac_model
+    repository-code: "https://github.com/stac-extensions/mlm/tree/main/stac_model"
+    repository-artifact: "https://pypi.org/project/stac-model/"
+    url: "https://github.com/stac-extensions/mlm/blob/main/README_STAC_MODEL.md"
+    authors:
+      - given-names: Ryan
+        family-names: Avery
+        alias: rbavery
+        email: ryan@wherobots.com
+        affiliation: "Wherobots, Inc."
+        orcid: "https://orcid.org/0000-0001-7392-1474"
+      - given-names: Francis
+        family-names: Charette-Migneault
+        alias: fmigneault
+        email: francis.charette-migneault@crim.ca
+        affiliation: Computer Research Institute of Montréal (CRIM)
+        orcid: "https://orcid.org/0000-0003-4862-3349"
+
+  - type: standard
+    title: STAC MLM specification
+    authors: *authors
+    identifiers:
+    - type: url
+      value: "https://stac-extensions.github.io/mlm/v1.3.0/schema.json"
+      description: "Latest extension URL used in 'stac_extensions' references."
+    - type: url
+      value: "https://stac-extensions.github.io/mlm/"
+      description: "Generic URL of the MLM extension schema versions for 'stac_extensions' references."
+
+  - type: software-code
+    title: "Archive repository of the STAC MLM specification."
+    repository-code: "https://github.com/crim-ca/mlm-extension"
+    authors: *authors
+    identifiers:
+    - type: url
+      value: "https://crim-ca.github.io/mlm-extension/v1.3.0/schema.json"
+      description: "Archive extension URL used in 'stac_extensions' references."
+    - type: url
+      value: "https://crim-ca.github.io/mlm-extension/"
+      description: "Generic URL of the archived MLM extension schema versions for 'stac_extensions' references."
+
+  - type: report
+    title: Project CCCOT03 – Technical Report
+    keywords:
+      - dlm
+      - Deep Learning
+      - Model
+      - STAC
+    repository: "https://raw.githubusercontent.com/crim-ca/CCCOT03/main/CCCOT03_Rapport%20Final_FINAL_EN.pdf"
+    repository-code: "https://github.com/crim-ca/dlm-extension"
+    license: Apache-2.0
+    license-url: https://github.com/crim-ca/dlm-extension/blob/main/LICENSE
+    date-released: "2020-12-14"
+    languages:
+      - en
+    authors:
+      - given-names: Francis
+        family-names: Charette-Migneault
+        alias: fmigneault
+        email: francis.charette-migneault@crim.ca
+        affiliation: Computer Research Institute of Montréal (CRIM)
+        orcid: "https://orcid.org/0000-0003-4862-3349"
+      - given-names: Samuel
+        family-names: Foucher
+        alias: sfoucher
+        orcid: "https://orcid.org/0000-0001-9557-6907"
+      - given-names: David
+        family-names: Landry
+        orcid: "https://orcid.org/0000-0001-5343-2235"
+      - given-names: Yves
+        family-names: Moisan
+        alias: ymoisan
+      - name: Computer Research Institute of Montréal
+        city: Montréal
+        region: Québec
+        alias: CRIM
+        website: "https://www.crim.ca/"
+        email: info@crim.ca
+        tel: 1 (514) 840-1234
+        country: CA
+        post-code: H3N 1M3
+        address: "101 – 405, avenue Ogilvy"
+      - name: "Natural Resources Canada"
+        country: CA
+        website: "https://natural-resources.canada.ca/"
+      - name: "Canada Centre for Mapping and Earth Observation"
+        alias: CCMEO
+        country: CA
+        website: "https://natural-resources.canada.ca/research-centres-and-labs/canada-centre-for-mapping-and-earth-observation/25735"
+
+preferred-citation:
+  type: conference-paper
+  doi: "10.1145/3681769.3698586"
+  title: Machine Learning Model Specification for Cataloging Spatio-Temporal Models
+  conference:
+    name: 3rd ACM SIGSPATIAL International Workshop on Searching and Mining Large Collections of Geospatial Data
+    alias: GeoSearch’24
+  date-released: "2024-10-29"
+  year: 2024
+  month: 11
+  pages: 4
+  location:
+    name: Georgia Tech Hotel and Conference Center
+    city: Atlanta
+    region: Georgia
+    country: US
+  languages:
+    - en
+  abstract: >-
+    The Machine Learning Model (MLM) extension is a
+    specification that extends the SpatioTemporal Asset
+    Catalogs (STAC) framework to catalog machine learning
+    models. This demo paper introduces the goals of the MLM,
+    highlighting its role in improving
+    searchability and reproducibility of geospatial models.
+    The MLM is contextualized within the STAC ecosystem,
+    demonstrating its compatibility and the advantages it
+    brings to discovering relevant geospatial models and
+    describing their inference requirements.
+
+    A detailed overview of the MLM's structure and fields
+    describes the tasks, hardware requirements, frameworks,
+    and inputs/outputs associated with machine learning
+    models. Three use cases are presented, showcasing the
+    application of the MLM in describing models for land cover
+    classification and image segmentation. These examples
+    illustrate how the MLM facilitates easier search and better
+    understanding of how to deploy models in inference pipelines.
+
+    The discussion addresses future challenges in extending
+    the MLM to account for the diversity in machine learning
+    models, including foundational and fine-tuned models,
+    multi-modal models, and the importance of describing the
+    data pipeline and infrastructure models depend on.
+    Finally, the paper demonstrates the potential of the MLM
+    to be a unifying standard to enable benchmarking and
+    comparing geospatial machine learning models.
+  keywords:
+    - STAC
+    - Catalog
+    - Machine Learning
+    - Spatio-Temporal Models
+    - Search
+  contact:
+    - given-names: Francis
+      family-names: Charette-Migneault
+      email: francis.charette-migneault@crim.ca
+      affiliation: Computer Research Institute of Montréal (CRIM)
+      orcid: "https://orcid.org/0000-0003-4862-3349"
+  authors:
+    - given-names: Francis
+      family-names: Charette-Migneault
+      email: francis.charette-migneault@crim.ca
+      affiliation: Computer Research Institute of Montréal (CRIM)
+      orcid: "https://orcid.org/0000-0003-4862-3349"
+    - given-names: Ryan
+      family-names: Avery
+      email: ryan@wherobots.com
+      affiliation: "Wherobots, Inc."
+      orcid: "https://orcid.org/0000-0001-7392-1474"
+    - given-names: Brian
+      family-names: Pondi
+      email: brian.pondi@uni-muenster.de
+      affiliation: "Institute for Geoinformatics, University of Münster"
+      orcid: "https://orcid.org/0009-0008-0367-1690"
+    - given-names: Joses
+      family-names: Omojola
+      affiliation: University of Arizona
+      email: jomojo1@arizona.edu
+      orcid: "https://orcid.org/0000-0001-5807-2953"
+    - given-names: Simone
+      family-names: Vaccari
+      email: simone.vaccari@terradue.com
+      affiliation: Terradue
+      orcid: "https://orcid.org/0000-0002-2757-4165"
+    - given-names: Parham
+      family-names: Membari
+      email: parham.membari@terradue.com
+      affiliation: Terradue
+      orcid: "https://orcid.org/0009-0004-7594-4011"
+    - given-names: Devis
+      family-names: Peressutti
+      email: devis.peressutti@planet.com
+      affiliation: "Sinergise Solutions, a Planet Labs company"
+      orcid: "https://orcid.org/0000-0002-4660-0576"
+    - given-names: Jia
+      family-names: Yu
+      email: jiayu@wherobots.com
+      affiliation: "Wherobots, Inc."
+      orcid: "https://orcid.org/0000-0003-1340-6475"
+    - given-names: Jed
+      family-names: Sundwall
+      email: jed@radiant.earth
+      affiliation: Radiant Earth
+      orcid: "https://orcid.org/0000-0001-9681-230X"

Makefile

@@ -55,7 +55,7 @@ test:
 	PYTHONPATH=$(PYTHONPATH) poetry run pytest -c pyproject.toml --cov-report=html --cov=stac_model tests/
 
 .PHONY: check
-check: check-examples check-markdown check-lint check-mypy check-safety
+check: check-examples check-markdown check-lint check-mypy check-safety check-citation
 
 .PHONY: check-all
 check-all: check
@@ -67,6 +67,13 @@ mypy:
 .PHONY: check-mypy
 check-mypy: mypy
 
+# NOTE:
+#  purposely running with docker rather than python package due to conflicting dependencies
+#  see https://github.com/citation-file-format/cffconvert/issues/292
+.PHONY: check-citation
+check-citation:
+	docker run --rm -v $(PYTHONPATH)/CITATION.cff:/app/CITATION.cff citationcff/cffconvert --validate
+
 .PHONY: check-safety
 check-safety:
 	$(POETRY) check

pyproject.toml

@@ -186,6 +186,11 @@ replace = """
 ## [v{new_version}](https://github.com/stac-extensions/mlm/tree/v{new_version})
 """
 
+[[tool.bumpversion.files]]
+filename = "CITATION.cff"
+search = "https://stac-extensions.github.io/mlm/v{current_version}/schema.json"
+replace = "https://stac-extensions.github.io/mlm/v{new_version}/schema.json"
+
 [tool.ruff]
 exclude = [
     ".git",