Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

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

Đã đóng
  • Có gì không ổn?
#306 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

@VassilisVassiliadis đang làm issue này rồi.

Từ ngày 9/10/2026.

  • #310 của @VassilisVassiliadis — đang mở

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
45/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
python
Lĩnh vực
cli

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
Python
Star
4
Fork
7
Merge trung bình
21 giờ 28 phút
Pull request đã merge (30 ngày)
26

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của IBM/algorithm-nexus

Tất cả issue của IBM/algorithm-nexus

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.