Skip to content

Add proposal for unified results directory structure #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
maryamtahhan wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add proposal for unified results directory structure #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8c844cd
Add proposal for unified results directory structure
maryamtahhan Mar 30, 2026
b7ef26d
Fix markdownlint errors in results directory proposal
maryamtahhan Mar 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion docs/docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,16 @@ docs/
│ ├── distributed-testing.md
│ └── playbook-reference.md
│
├── proposals/ # Design proposals
│ ├── README.md # Proposal workflow
│ └── results-directory-structure.md
│
└── reference/ # Reference documentation
├── model-yaml-schema.md
├── test-yaml-schema.md
├── matrix-yaml-schema.md
└── cli-reference.md
```text
```

## Documentation by Topic

Expand Down Expand Up @@ -93,6 +97,14 @@ docs/
2. [Test Scenario Schema](reference/test-yaml-schema.md) - Test YAML format
3. [CLI Reference](reference/cli-reference.md) - Command-line tool reference

### Design Proposals

Design proposals for changes to the framework:

1. [Proposals Overview](proposals/README.md) - Proposal workflow and guidelines
2. [Results Directory Structure](proposals/results-directory-structure.md) -
Unified results structure and custom test run names

## Contributing to Documentation

Documentation is written in Markdown and follows these conventions:
Expand All @@ -118,6 +130,7 @@ pre-commit run --all-files
| methodology/metrics.md | ✅ Complete | 2024-02-08 |
| methodology/reporting.md | ✅ Complete | 2024-02-08 |
| platform-setup/x86/intel/deterministic-benchmarking.md | ✅ Complete | (current) |
| proposals/results-directory-structure.md | 🚧 In Review | 2024-03-30 |
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Mar 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Update stale “Last Updated” year for the new proposal entry.

Line 133 uses 2024-03-30, but this PR was created on 2026-03-30. Keeping the year aligned avoids timeline confusion in the status table.

Suggested fix 
-| proposals/results-directory-structure.md | 🚧 In Review | 2024-03-30 |
+| proposals/results-directory-structure.md | 🚧 In Review | 2026-03-30 |
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
| proposals/results-directory-structure.md | 🚧 In Review | 2024-03-30 |
| proposals/results-directory-structure.md | 🚧 In Review | 2026-03-30 |
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@docs/docs.md` at line 133, Update the stale date in the documentation table
row that currently reads "proposals/results-directory-structure.md | 🚧 In
Review | 2024-03-30" to the correct creation date "2026-03-30"; locate the
string in docs/docs.md (the table entry for
proposals/results-directory-structure.md) and replace the year portion of the
date only so the row becomes "proposals/results-directory-structure.md | 🚧 In
Review | 2026-03-30".

| containers/* | 📝 Planned | - |
| ansible/* | 📝 Planned | - |
| getting-started/* | 📝 Planned | - |
Expand Down
26 changes: 26 additions & 0 deletions docs/proposals/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Proposals

This directory contains design proposals for the vLLM CPU Performance Evaluation framework.

## Active Proposals

- [**Results Directory Structure**](results-directory-structure.md) - Unified results directory structure and custom test run names (addresses [Issue #73](https://github.com/redhat-et/vllm-cpu-perf-eval/issues/73))

## Proposal Workflow

1. **Draft**: Create a proposal document in this directory
2. **Review**: Share with team for feedback and discussion
3. **Approved**: Update implementation checklist and create tracking issues
4. **Implemented**: Mark as completed and link to PRs

## Template

New proposals should include:

- **Summary**: What problem does this solve?
- **Current State**: What's the problem with the current approach?
- **Proposed Solution**: Detailed design with examples
- **Migration Strategy**: How to transition (if breaking change)
- **Implementation Checklist**: Specific tasks required
- **Questions for Review**: Open questions for team discussion
- **Alternatives Considered**: What other approaches were evaluated?
Loading
Loading