stats package #120
Merged
stats package #120
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
…wargs when calling from the Hypergraph itself
…only return a single element, while there may be multiple elements that achieve the maximum
…odeStats. Also, add the dist() convenience function
…cher object itself
…cstring uses the function "my_degree". However, the test_user_defined test function also defined a function with name "my_degree". The latter was leaking into the namespace during pytest runs so we decided to change the name of the latter to "user_degree" instead.
…stead of the underlying view
…ng py3.8 so the tests on 3.7 were failing. Also, turned one docstring into a raw string
…the cells in the notebook raises an exception, even if the exception was intentional...
|
|
nwlandry
reviewed
Jun 11, 2022
nwlandry
reviewed
Jun 11, 2022
| @@ -0,0 +1,35 @@ | |||
| xgi.stats.EdgeStat | |||
There was a problem hiding this comment.
There seem to be a few duplicate file names in docs/source/api/stats
There was a problem hiding this comment.
All of nodestats, NodeStat, and nodestat are valid names implemented in this PR: the module, the class, and the decorator. All three names are imported into the xgi.stats package, so sphinx creates all three files.
I think it's fine, at least documentation-wise, though these three names are too similar to each other that they may eventually cause a problem with end-users?
There was a problem hiding this comment.
Open to suggestions here
nwlandry
reviewed
Jun 11, 2022
nwlandry
reviewed
Jun 11, 2022
nwlandry
reviewed
Jun 11, 2022
…he documentation tree that differed only in the case of some of the characters; this was causing problems for git on windows. So we have changed the decorators nodestat and edgestat to nodestat_func and edgestat_func. Additionally, we also fixed some documentation errors
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.
This PR adds the
statspackage which implementsNodeStat,EdgeStatand related functionality. For an overview of all the new features, see the tutorial.The main changes are all within the newly created
xgi/stats/package. Other classes affected areHypergraph,NodeView, andEdgeView. Additionally,DegreeViewandEdgeSizeVieware deleted.This is a big diff, but it can basically be broken in three: changes to the docs (docstrings and *rst files), new tests (this PR adds 51 new tests collected by pytest), and the actual implementation, which is mostly within
xgi/stats/,xgi/classes/hypergraph.pyandxgi/classes/reportviews.py.In terms of documentation, I believe we now have the minimum required to make sense of the new features, but a lot more can be done for sure. To avoid repetition, in some places I just added a direct link to the tutorial.
On a technical note. The way the
xgi/stats/package is implemented is the following.xgi/stats/__init__.pycontains all the major classes and decorators.xgi/stats/nodestats.pycontains only the functions that actually compute node statistics (like degree clustering, etc). Similarly,xgi/stats/edgestats.pycontains only the functions that compute edge statistics. I don't like having so much code in the__init__.pymodule, but it is necessary for the current implementation thatnodestats.pyandedgestats.pyONLY contain functions that compute the corresponding statistics.