Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

numpy style docstrings #84

Merged
merged 1 commit into from
Jan 11, 2023
Merged

numpy style docstrings #84

merged 1 commit into from
Jan 11, 2023

Conversation

HarshaSatyavardhan
Copy link

@HarshaSatyavardhan HarshaSatyavardhan commented Jan 8, 2023 •
edited
Loading

Fixes #

Changes proposed in this pull request:

  • added numpy style docstrings

Before submitting

  • I've read and followed all steps in the Making a pull request
    section of the CONTRIBUTING docs.
  • I've updated or added any relevant docstrings following the syntax described in the
    Writing docstrings section of the CONTRIBUTING docs.
  • If this PR fixes a bug, I've added a test that will fail without my fix.
  • If this PR adds a new feature, I've added tests that sufficiently cover my new functionality.

After submitting

  • All GitHub Actions jobs for my pull request have passed.

robertness
robertness reviewed Jan 11, 2023
View reviewed changes
dodiscover/replearning/gin.py
@@ -51,8 +87,21 @@ def _extract_edgelists(adj_mat, names):
return pdag


def fit(self, data, context):
def fit(self, data: 'DataFrame', context: 'DataFrame'):
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a context is an instance of the Context class.

robertness
robertness reviewed Jan 11, 2023
View reviewed changes
dodiscover/replearning/gin.py
----------
data : DataFrame
The data to fit to.
context : DataFrame
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

see comment above

robertness
robertness approved these changes Jan 11, 2023
View reviewed changes
Copy link
Collaborator

@robertness robertness left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this looks good. Looking over the GIN code, I can't think of any reason to make this interface more complicated than it is. Make that adjustment for the Context type hint and we can get this merged.

@robertness
Copy link
Collaborator

Also @HarshaSatyavardhan, this: #87

@adam2392
Copy link
Collaborator

Some CI failures:

@robertness
Copy link
Collaborator

Merging in to GIN PR

@robertness robertness merged commit 90a2794 into py-why:GIN-algorithm Jan 11, 2023
robertness pushed a commit that referenced this pull request Jan 11, 2023
@HarshaSatyavardhan @robertness
numpy style docstrings (#84)
9567b22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@robertness robertness robertness approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@HarshaSatyavardhan @robertness @adam2392