Clarification on siteonlyapi documentation#957
Open
BenjaminFrazer wants to merge 1 commit into
Open
Conversation
Took me a while to figure out exactly what this flag was doing, and wasn't explicitly clear from anything in this documentation, so I added some clarification as I understand it.
levaphenyl
requested changes
Aug 11, 2022
| "# Diasaggregate your Home/Building Mains Meter Data\n", | ||
| "\n", | ||
| "### This notebook demonstrates the use of siteonlyapi - a new NILMTK interface which is a modification of NILMTK's ExperimentAPI. It allows NILMTK users to get their home/buildings energy demands for different potential appliances.\n", | ||
| "### This notebook demonstrates the use of siteonlyapi - a new flag option within the NILMTK Experiment API interface which allows the user to run disaggregation on only site data without sub-meter information as the testing stage. This of course means that there is no possibility to asses the algorithm's accuracy in these tests. It allows NILMTK users to get their home/buildings energy demands for different potential appliances.\n", |
Collaborator
There was a problem hiding this comment.
I agree the current description lacks clarity. I would mention in the explanation the word "unsupervised". What do you think of the following beginning?
This notebook demonstrates the site_only option of the NILMTK Experiment API. This flag allows the user to run unsupervised disaggregation on site data only, without sub-meter information at the testing stage. [...]
I am happy with the rest of your text.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Took me a while to figure out exactly what this flag was doing, and wasn't explicitly clear from anything in this documentation, so I added some clarification as I understand it.