Skip to content

Updating docs to mention vtr_reg_nightly parallelism strategy #1776

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

Merged

Conversation

ArashAhmadian
Copy link
Contributor

Description

Updated README.developers.md to go over parallelism strategy and give detailed steps for adding new suites.

Motivation and Context

To update the document to be inline with #1728.

Types of changes

  • Bug fix (change which fixes an issue)
  • New feature (change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My change requires a change to the documentation
  • I have updated the documentation accordingly
  • I have added tests to cover my changes
  • All new and existing tests passed

@github-actions github-actions bot added the docs Documentation label Jun 10, 2021
@ArashAhmadian
Copy link
Contributor Author

@vaughnbetz the doc additions are ready for review.

@ArashAhmadian ArashAhmadian mentioned this pull request Jun 10, 2021
5 tasks
@ArashAhmadian ArashAhmadian changed the title Updating docs to mention vtr_reg_nightly parallelism strategy a Updating docs to mention vtr_reg_nightly parallelism strategy Jun 14, 2021
@github-actions github-actions bot removed the docs Documentation label Jun 14, 2021
@github-actions github-actions bot added the docs Documentation label Jun 14, 2021
**Feature Coverage:** Medium

**Benchmarks:** Small-medium size, diverse. Includes:

* VTR benchmarks
* Titan 'other' benchmarks (smaller than Titan23)
Copy link
Contributor

Choose a reason for hiding this comment

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

Doesn't it include most of the titan23 benchmarks too?

Copy link
Contributor

Choose a reason for hiding this comment

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

I think this documentation could be refactored to be shorter. State all the things that pertain to all vtr_nightly tests together, and then state only the details that are different for each sub-test. Essentially these comprise one set of tests that should be checked before a PR (and are checked by CI) but they are split into sub-suites for more parallel execution during CI.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure. I made changes based on the suggestions

@vaughnbetz
Copy link
Contributor

Mostly good, but please see my comments above about refactoring the vtr_reg_nightly part of README_developers.md to be shorter (avoid repeating things 3 times and highlight that vtr_reg_nightlyX are all related).

@ArashAhmadian
Copy link
Contributor Author

@vaughnbetz The new changes are ready for review.

@vaughnbetz
Copy link
Contributor

Looks good; thanks Arash.

@vaughnbetz vaughnbetz merged commit 1e2d018 into verilog-to-routing:master Jun 21, 2021
@ArashAhmadian ArashAhmadian deleted the docs_update_vtr_reg_nightly branch August 1, 2021 21:50
@ArashAhmadian ArashAhmadian restored the docs_update_vtr_reg_nightly branch August 1, 2021 21:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants