Algorithm Documentation Edits #29
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updated the documentation. Primarily focused on updating the description of the algorithm used to generate the similar tracks. Added specific information about how paramters are calculated and used
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
README documentation focused on the algorithm to produce similar tracks for a new playlist has been updated. Points are expanded to provide more specific information on what the algorithm is doing. Specific information and numbers from the code are now included.
Should help provide more context to users, who can now better understand how the results are generated. Additionally, should help future contributors by communicating more specifically how the code works.
Finally, a small modification is made to the prerequisites section to better reflect the full workflow.
Thank you!