Skip to content

Registry & Plugins

Registry and Plugins

Registry

  • The FeatureModelRegistry (src/foodspec/registry.py) records runs and models:
  • dataset hash or input files
  • protocol name/version
  • preprocessing config
  • validation strategy
  • features used
  • model path/type and metrics
  • provenance (timestamp/user/tool version)
  • CLI:
  • foodspec-registry --registry registry.json --query-protocol EdibleOil_Classification_v1
  • foodspec-registry --registry registry.json --query-feature I_1742
  • Python: 
    from foodspec.registry import FeatureModelRegistry
reg = FeatureModelRegistry(Path("~/.foodspec_registry.json").expanduser())
entries = reg.query_by_protocol("EdibleOil_Classification_v1")
print(entries)

# Query models by protocol and feature
models = [e for e in entries if e.model_id]
feat_hits = reg.query_by_feature("I_1742")
print(models, feat_hits)
  • Auto-registration: set FOODSPEC_REGISTRY when saving models to log them automatically.

Plugins

  • Discovery via entry points (foodspec.plugins). Plugin manager loads protocol templates, vendor loaders, harmonization strategies, feature indices, and workflows.
  • CLI:
  • foodspec-plugin list
  • foodspec-plugin install plugin_example_protocol
  • Example plugins:
  • examples/plugins/plugin_example_protocol: registers a simple protocol template.
  • examples/plugins/plugin_example_vendor: adds a dummy vendor loader (*.toy).
  • examples/plugins/plugin_example_indices: registers a demo feature index.
  • examples/plugins/plugin_example_workflow: registers a minimal workflow.
  • Programmatic discovery and registration into runtime registries: 
    from foodspec.plugins import load_plugins
from foodspec.plugins.loaders import vendor_loader_registry
from foodspec.plugins.indices import feature_index_registry
from foodspec.plugins.workflows import workflow_registry

pm = load_plugins()  # discovers entry points and populates registries
print(pm.protocols)
print(vendor_loader_registry.available())
print(feature_index_registry.available())
print(workflow_registry.available())
  • Plugin entry points can optionally return feature_indices and workflows keys from get_plugins():
  • {"feature_indices": {"MyIndex": {...}}, "workflows": {"MyWorkflow": callable}}

  • Example pyproject.toml entry:

    [project.entry-points."foodspec.plugins"]
plugin_example_indices = "plugin_example_indices:plugin_main"
plugin_example_workflow = "plugin_example_workflow:plugin_main"