Skip to content

Noc documentation #2346

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
merged 7 commits into from
Jul 8, 2023
Merged

Noc documentation #2346

merged 7 commits into from
Jul 8, 2023

Conversation

Srivat97
Copy link
Contributor

@Srivat97 Srivat97 commented Jul 7, 2023

Adding documentation for the NoC related data structures.

Description

Created a new section under VPR INTERNALS called VPR NoC. This section includes documentation for the following data structures:

  • NoC Router
  • NoC Link
  • NoC Storage
  • NoC Traffic Flows
  • NoC Routing
  • NoC Data Types

Related Issue

Motivation and Context

Its good to have documentation for all internal datastructures within VPR.

How Has This Been Tested?

THis has been tested by building the documentation locally and visually verifying the docs.

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
  • [x ] 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 VPR VPR FPGA Placement & Routing Tool label Jul 7, 2023
@Srivat97 Srivat97 merged commit 8d119de into master Jul 8, 2023
@Srivat97 Srivat97 deleted the noc_documentation branch July 8, 2023 17:23
@Srivat97
Copy link
Contributor Author

Srivat97 commented Jul 8, 2023

@vaughnbetz Looks like the failing check is not related to my changes, check failed with the following error:
"b'GPGKeyTemporarilyNotFoundError'"

So merging my changes in.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
VPR VPR FPGA Placement & Routing Tool
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant