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.

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

DFT Part-3 #3817

Merged
merged 23 commits into from
Mar 5, 2024
Merged

DFT Part-3 #3817

merged 23 commits into from
Mar 5, 2024

Conversation

GreatRSingh
Copy link
Contributor

@GreatRSingh GreatRSingh commented Feb 5, 2024

Description

Fix #(issue)

Type of change

Please check the option that is related to your PR.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
    • In this case, we recommend to discuss your modification on GitHub issues before creating the PR
  • Documentations (modification for documents)

Checklist

  • My code follows the style guidelines of this project
    • Run yapf -i <modified file> and check no errors (yapf version must be 0.32.0)
    • Run mypy -p deepchem and check no errors
    • Run flake8 <modified file> --count and check no errors
    • Run python -m doctest <modified file> and check no errors
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • New unit tests pass locally with my changes
  • I have checked my code and corrected any misspellings

@@ -0,0 +1,542 @@
import torch
Copy link
Member

Choose a reason for hiding this comment

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

Don't have _jacobian.py, rename to jacobian.py



class Jacobian(object):
"""Base class for the Jacobians used in rootfinder algorithms."""
Copy link
Member

Choose a reason for hiding this comment

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

Add a longer comment here; this is an important class

>>> jacobian.solve(v)
tensor([-0.7071, -0.7071], grad_fn=<MulBackward0>)

[1].. B.A. van der Rotten, PhD thesis,
Copy link
Member

Choose a reason for hiding this comment

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

This should be in a references section


"""

def __init__(self, alpha=None, uv0=None, max_rank=None):
Copy link
Member

Choose a reason for hiding this comment

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

Missing type annotations

# taking most of the part from SciPy


class Jacobian(object):
Copy link
Member

Choose a reason for hiding this comment

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

Add type annotations on all this code



class LinearMixing(Jacobian):
""" Approximating the Jacobian based on linear mixing.
Copy link
Member

Choose a reason for hiding this comment

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

Add details on the algorithm. I'm not familiar with LinearMixing



class LowRankMatrix(object):
"""represents a matrix of `\alpha * I + \sum_n c_n d_n^T`
Copy link
Member

Choose a reason for hiding this comment

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

More details here

del self.dns[:n - max_rank]


class FullRankMatrix(object):
Copy link
Member

Choose a reason for hiding this comment

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

More details here; type annotations

@@ -0,0 +1,161 @@
import warnings
import torch
Copy link
Member

Choose a reason for hiding this comment

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

For code adapted from xitorch, let's add links in docstring to original source

Copy link
Member

@rbharath rbharath left a comment

Choose a reason for hiding this comment

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

Not in bad shape but needs more documentation and type annotations primarily. Once those are fixed and CI is running again good to merge

Copy link
Member

@rbharath rbharath left a comment

Choose a reason for hiding this comment

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

LGTM

This is a large PR but checking I think there are no new failures.

@GreatRSingh Let's coordinate at next OH about remaining dqc/xitorch port PRs

@rbharath rbharath merged commit 7f4ba07 into deepchem:master Mar 5, 2024
25 of 33 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants