feat: attach user-defined metadata to Nexus YAML manifest files
维护者通常 1 天内回复
评估
调研方向
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.
由索引模型根据 Issue 内容生成。
描述
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.
- 主要语言
- Python
- 星标
- 4
- 派生
- 7
- 平均合并
- 17 小时 4 分钟
- 30 天内合并 PR
- 29
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
IBM/algorithm-nexus 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 68/100
IBM/algorithm-nexus#159 ·
维护者通常 1 天内回复
-
feat: Per benchmark instance properties可能已有人在做 @christian-pinto 于 4 天前认领。 未关闭enhancement
IBM/algorithm-nexus#300 · 已指派 1 人 ·
维护者通常 1 天内回复
-
feat: allow specifying multiple values for properties in an instance可能已有人在做 @christian-pinto 于 13 天前认领。 未关闭enhancement
IBM/algorithm-nexus#277 · 1 条评论 · 已指派 1 人 ·
维护者通常 1 天内回复
-
难度 3/5 1-2 天 新手友好度 68/100
IBM/algorithm-nexus#276 ·
维护者通常 1 天内回复
-
难度 3/5 1-2 天 新手友好度 45/100
IBM/algorithm-nexus#254 ·
维护者通常 1 天内回复
查看 IBM/algorithm-nexus 的全部 Issue
相似的 Issue
-
难度 1/5 1 小时以内 新手友好度 60/100
521xueweihan/HelloGitHub#3924 ·
-
难度 2/5 1-3 小时 新手友好度 67/100
wilbowes/EchoMuse#869 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 85/100
-
namespace operations
难度 1/5 1 小时以内 新手友好度 72/100
EclipseFdn/open-vsx.org#14043 ·
维护者通常 1 天内回复
-
test: TestServeUntilStale races the server's close against the client's sendall (BrokenPipeError under load)可能已有人在做 @evoludigit 今天认领。 未关闭
难度 1/5 1 小时以内 新手友好度 89/100
维护者通常 1 天内回复