Updates example section in the Readme #48
Conversation
This file contains 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
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
…e package and is only used for the repo
for more information, see https://pre-commit.ci
|
Hey @Trybnetic, is this still a work in progress ? |
|
I actually struggled with explaining on the use of |
…found in the .github/ folder
Comment on lines
+124
to
+128
| However, not always you have or can have the data available in the format mentioned in | ||
| the previous example (e.g. if the dataset is too large). In this case, the weights | ||
| between the true and predicted labels can also be calculated beforehand and used to | ||
| create the sankey diagram. In this example, we continue to work with the data loaded | ||
| already in the previous example: |
There was a problem hiding this comment.
Suggested change
| However, not always you have or can have the data available in the format mentioned in | |
| the previous example (e.g. if the dataset is too large). In this case, the weights | |
| between the true and predicted labels can also be calculated beforehand and used to | |
| create the sankey diagram. In this example, we continue to work with the data loaded | |
| already in the previous example: | |
| However, the data may not always be available in the format mentioned in | |
| the previous example (for instance, if the dataset is too large). In such cases, the weights | |
| between the true and predicted labels can be calculated in advance and used to | |
| create the Sankey diagram. In this example, we will continue working with the data that was loaded | |
| in the previous example: |
Comment on lines
+16
to
+17
| `pysankey` contains a simple expected/predicted dataset called `fruits.txt` which looks | ||
| the following: |
There was a problem hiding this comment.
Suggested change
| `pysankey` contains a simple expected/predicted dataset called `fruits.txt` which looks | |
| the following: | |
| `pysankey` contains a simple expected/predicted dataset called `fruits.txt` which looks | |
| like the following: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
As outlined in #47, this PR updates the documentation in the readme. Specifically, I made the examples consistent in the sense that they are both using the
fruits.txtdataset now and extended the descriptions of the examples a bit.Changes introduced in this PR:
fruits.txtin the examplesI see some further changes that could be included in this PR:
leftWeightandrightWeight