Skip to content
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.

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

Matching hardware and software stack distinction in the docs #561

Merged
merged 1 commit into from
Jan 26, 2025

Conversation

pearce8
Copy link
Collaborator

@pearce8 pearce8 commented Jan 23, 2025

Description

Reflecting the hardware vs. software stack distinction in the docs.

Dependencies: none.

Fixes issue(s): none.

Type of Change

  • { } Adding a system, benchmark, or experiment
  • { } Modifying an existing system, benchmark, or experiment
  • {X} Documentation update
  • { } Build/CI update
  • { } Benchpark core functionality

Checklist:

If adding/modifying a system:

  • { } Create a new directory for the system and a new system.py file
  • { } Add a new dry run unit test in .github/workflows
  • { } System appears in System Specifications table in docs catalogue section

If adding/modifying a benchpark:

  • { } Add a new application.py and (maybe) package.py under a new directory
    for this benchmark
  • { } Configure an experiment
  • { } Benchmark appears in Benchmarks and Experiments table in docs catalogue
    section

If adding/modifying a experiment:

  • { } Extend experiment.py under existing directory for specific benchmark
  • { } Define a single node and multi-node experiments

If adding/modifying core functionality:

  • { } Update docs
  • { } Update .github/workflows and .gitlab/ci unit tests (if needed)

@pearce8 pearce8 requested a review from dyokelson January 23, 2025 08:37
@github-actions github-actions bot added the docs Improvements or additions to documentation label Jan 23, 2025
@pearce8 pearce8 merged commit cd0f42e into develop Jan 26, 2025
16 checks passed
@pearce8 pearce8 deleted the pearce8-patch-4 branch January 26, 2025 18:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant