Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

feat: attach user-defined metadata to Nexus YAML manifest files

Aperta
  • Qualcosa non va?
#306 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

@VassilisVassiliadis ci sta già lavorando.

Dal 9/10/2026.

  • #310 di @VassilisVassiliadis — aperta

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
45/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
python
Ambito
cli

Direzione di ricerca

The payload names no source files, so start by finding the nexus validate entry point and the schema or parser for the benchmark, instance, experiment package and binding YAML formats. Add an optional flat string-to-string metadata field, with keys and values capped at 4096 characters, to all four. Done when a manifest containing metadata passes nexus validate, and a manifest with an over-long key or value is rejected.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement

Is your feature request related to a problem? Please describe.

There is no supported way to attach arbitrary key-value annotations to a Nexus manifest YAML files.

To work around this, I need to store that context outside Nexus (in README.md files, custom YAML/JSON files, etc) and must manually associate these files with the nexus YAML manifests.

Describe the solution you'd like.

Add an optional top-level metadata field to benchmark, benchmark instance, experiment, and binding YAML files. The field accepts a flat string-to-string dictionary. Both keys and values are strings of up to 4 096 characters. The field is optional and may be omitted entirely.

Example benchmark.yaml with the new field:

benchmarkIdentifier: inference_serving
title: Inference Serving Benchmark
metadata:
  data_source_version: "v2.1.0"
  owning_team: "platform-perf"

Example instance.yaml with the new field:

instanceIdentifier: small_model_8b
benchmarkIdentifier: inference_serving
metadata:
  region: "us-south"
  endpoint-url: "http://ibm.com/my-endpoint/"

Example experiment_package.yaml with the new field:

experiment_package:
  requirement_specifier: https://github.com/IBM/my-experiment.git
  experiments:
    - my_experiment
metadata:
  author: IBM

Example binding YAML with the new field:

instanceBindingIdentifier: my_binding
instanceReference: inference_serving/small_model_8b
metadata:
  run_label: "nightly-2025-07-01"

The nexus validate command should accept files that include this field without reporting a validation error.

Describe alternatives you've considered.

Using YAML comments (# key: value) to store annotations: this is unstructured and not accessible to the CLI or any downstream tooling; it cannot be queried or validated.

Using the existing description string field on benchmark and instance: this is a hack that misues the description field, conflating human-readable text with machine-readable tags.

Lingua principale
Python
Stelle
4
Fork
7
Merge medio
17h 4m
PR unite (30g)
29

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di IBM/algorithm-nexus

Tutte le issue di IBM/algorithm-nexus

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.