Skip to content

Commit bab2d3b

Browse files
committed
Clarify meta field completeness and validation requirements in meta.md, as suggested by validation analysis PDF
1 parent 114515a commit bab2d3b

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

docs/src/meta.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,16 @@ using OptimizationProblems
88

99
Each problem has its own metadata structure, and there is a global metadata structure regrouping all the information.
1010

11+
> **Meta field completeness:**
12+
> All meta fields must be accurate and complete, including `nvar`, `ncon`, linear/nonlinear counts, bounds, minimize, feasibility ordering, origin, objtype, contype, and best-known bounds. Meta validation is enforced by the test suite. Incomplete or incorrect meta fields may cause solver failures or benchmarking errors.
13+
1114
## Problem's metadata
1215

1316
Each problem's metadata is accessible with `OptimizationProblems.nameoftheproblem_meta` and regroups in a `Dict` most of the essential information regarding each problem.
1417

18+
> **Meta validation:**
19+
> Meta fields are used for problem classification, filtering, and benchmarking. Ensure all fields are correct and consistent with the actual problem implementation. The test suite checks meta field accuracy.
20+
1521
```@example 1
1622
OptimizationProblems.AMPGO02_meta
1723
```

0 commit comments

Comments
 (0)