Diagram visualization of the CosyVoice codebase #1411
+1,057
−0
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In this PR I am adding high-level diagrams which represent the CosyVoice codebase.
You can see how the proposed changes render here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/CosyVoice/on_boarding.md
The CosyVoice repo has 1.6+k forks, that means that people are interested in playing around with the codebase itself. It is often the case that people just want to adjust slightly the codebase - the diagram give a high-level overview of the project so a person can see where they want to edit (as it is also linked with the source code). I'd love to hear where do you stand on diagram first documentation!
I'd usually open a discussion first, but you don't have them enabled for this repo so I decided to go ahead and open a PR.
Any feedback is more than welcome!
Full transparency: we’re exploring this idea as a potential startup, but we’re still early and figuring out what’s actually useful to developers.