stac-model
Python Version Support
Python Version Compatibility:
stac-model Version |
Python Version |
|---|---|
>=0.6.0 |
3.11+ |
<0.6.0 |
3.10+ |
Installation
pip install -U stac-model
or install with uv:
uv add stac-model
Then you can run
stac-model --help
Creating example metadata JSON for a STAC Item
stac-model
This will make this example item for an example model.
Validating Model Metadata
An alternative use of stac_model is to validate config files containing model metadata using the MLModelProperties schema.
Given a YAML or JSON file with the structure in examples/torch/mlm-metadata.yaml, the model metadata can be validated as follows:
import yaml
from stac_model.schema import MLModelProperties
with open("examples/mlm-metadata.yaml", "r", encoding="utf-8") as f:
metadata = yaml.safe_load(f)
MLModelProperties.model_validate(metadata["properties"])
Exporting and Packaging PyTorch Models, Transforms, and Model Metadata
As of PyTorch 2.8, and stac_model 0.4.0, you can now export and package PyTorch models, transforms,
and model metadata using functions in stac_model.torch.export. Below is an example of exporting a
U-Net model pretrained on the Fields of The World (FTW) dataset for
field boundary segmentation in Sentinel-2 satellite imagery using the TorchGeo library.
📝 Note: To customize the metadata for your model you can use this example as a template.
import torch
import torchvision.transforms.v2 as T
from torchgeo.models import Unet_Weights, unet
from stac_model.torch.export import save
weights = Unet_Weights.SENTINEL2_3CLASS_FTW
transforms = torch.nn.Sequential(
T.Resize((256, 256)),
T.Normalize(mean=[0.0], std=[3000.0]),
)
model = unet(weights=weights)
save(
output_file="ftw.pt2",
model=model, # Must be an nn.Module
transforms=transforms, # Must be an nn.Module
metadata="metadata.yaml", # Can be a metadata yaml or stac_model.schema.MLModelProperties object
input_shape=[-1, 8, -1, -1], # -1 indicates a dynamic shaped dimension
device="cpu",
dtype=torch.float32,
aoti_compile_and_package=False, # True for AOTInductor compile otherwise use torch.export
)
The model, transforms, and metadata can then be loaded into an environment with only torch and stac_model as required dependencies like below:
import yaml
from torch.export.pt2_archive._package import load_pt2
pt2 = load_pt2(archive_path)
metadata = yaml.safe_load(pt2.extra_files["mlm-metadata"])
# If exported with aoti_compile_and_package=True
model = pt2.aoti_runners["model"]
transforms = pt2.aoti_runners["transforms"]
# If exported with aoti_compile_and_package=False
model = pt2.exported_programs["model"].module()
transforms = pt2.exported_programs["transforms"].module()
# Inference
batch = ... # An input batch tensor
outputs = model(transforms(batch))
Creating a STAC Item from a PyTorch Model
You can generate a valid STAC Item using the Machine Learning Model (MLM) Extension.
The example below demonstrates creating a STAC Item from a U-Net model pretrained on the Fields of The World (FTW) dataset for field boundary segmentation in Sentinel-2 satellite imagery, using the TorchGeo library
from stac_model.examples import unet_mlm
from stac_model.torch import MLModelExtension
from torchgeo.models import unet, Unet_Weights
# Use default TorchGeo UNet weights
weights = Unet_Weights.SENTINEL2_2CLASS_NC_FTW
model = unet(weights=weights)
# Create an ItemMLModelExtension using the MLM extension
item_ext = MLModelExtension.from_torch(
model,
weights=weights,
item_id="pytorch_geo_unet",
)
For a more complete example including STAC Item properties, geometry, and datetime ranges,
see unet_mlm() in stac_model/examples.py.
📈 Releases
You can see the list of available releases on the GitHub Releases page.
For release procedure, see Building and Releasing.
📄 License
This project is licenced under the terms of the Apache Software License 2.0 licence.
See LICENSE for more details.
💗 Credits
Metadata
Release files for stac-model 0.7.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| stac_model-0.7.0.tar.gz | 38.8 kB | Without provenance | Details for stac_model-0.7.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| stac_model-0.7.0-py3-none-any.whl | Python 3 | none | any | Details for stac_model-0.7.0-py3-none-any.whl |
Total release size: 69.5 kB
Release files / stac_model-0.7.0.tar.gz
| Download URL | stac_model-0.7.0.tar.gz |
|---|---|
| Size | 38.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a3898a8cd89965813f4ab2bfe21096fe344a7dbedfef29e7c3a46838b057c722
|
|
BLAKE2b-256 checksum How to use checksums |
f59fabce46b878442efc1a1312edfa9aa07621983ae2d090b3b664907ef695f9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.19 {"installer":{"name":"uv","version":"0.12.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / stac_model-0.7.0-py3-none-any.whl
| Download URL | stac_model-0.7.0-py3-none-any.whl |
|---|---|
| Size | 30.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
17ce9d855aa88be2dbccfe4fbd36cef2aaa175608edff63a581531e13220dc85
|
|
BLAKE2b-256 checksum How to use checksums |
88ca1549c012be4f18574e9b642b99c13cd42b01d70788b57dfbd4903ee67da7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.19 {"installer":{"name":"uv","version":"0.12.19","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for stac-model 0.7.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.