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

feat: Add data commons toolkit #979

Draft
wants to merge 10 commits into
base: master
Choose a base branch
from
Draft

feat: Add data commons toolkit #979

wants to merge 10 commits into from

Conversation

dxmaptin
Copy link
Collaborator

@dxmaptin dxmaptin commented Sep 21, 2024

Description

Integrate DataCommons

Motivation and Context

close #935

  • I have raised an issue to propose this change (required for new features and bug fixes)

Types of changes

What types of changes does your code introduce? Put an x in all the boxes that apply:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds core functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (update in the documentation)
  • Example (update in the folder of example)

Implemented Tasks

  • Subtask 1
  • Subtask 2
  • Subtask 3

Checklist

Go over all the following points, and put an x in all the boxes that apply.
If you are unsure about any of these, don't hesitate to ask. We are here to help!

  • I have read the CONTRIBUTION guide. (required)
  • My change requires a change to the documentation.
  • I have updated the tests accordingly. (required for a bug fix or a new feature)
  • I have updated the documentation accordingly.

@Wendong-Fan Wendong-Fan added this to the Sprint 12 milestone Sep 22, 2024
@Wendong-Fan Wendong-Fan linked an issue Sep 22, 2024 that may be closed by this pull request
2 tasks
@Wendong-Fan Wendong-Fan marked this pull request as draft September 22, 2024 10:29
Copy link
Member

@Wendong-Fan Wendong-Fan left a comment

Choose a reason for hiding this comment

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

Thanks @dxmaptin 's contribution! docstring and type hint can be further polished, overall looks good to me

Copy link
Member

Choose a reason for hiding this comment

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

seems this file need to be cleaned

from typing import Any, Dict, List, Optional, Union

import datacommons
import datacommons_pandas as dc
Copy link
Member

Choose a reason for hiding this comment

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

the abbreviation makes it not so easy to be understood, how about use the original name?

"""

@staticmethod
def query_data_commons(query_string, select_function=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 hint for argument and output

Comment on lines +46 to +47
list: A list of dictionaries, each representing a node matching the
query conditions.
Copy link
Member

Choose a reason for hiding this comment

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

docstring format need to be aligned with above

return {}

@staticmethod
def get_property_labels(dcids, out=True):
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 hint

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

[Feature Request] Integrate DataCommons
2 participants