-
Notifications
You must be signed in to change notification settings - Fork 123
Add utilities to shard CSV/MCF files #1579
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
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @ajaits, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request introduces a robust set of utilities for sharding large CSV and MCF (McfFile) files. It provides a flexible framework to read and write dictionary-like data from these file types and then distribute records into multiple smaller files based on a configurable sharding key, offering features like duplicate handling and sampling.
Highlights
- New File I/O Abstraction: Introduced FileDictIO as an abstract base class, with concrete implementations CsvFileDictIO and McfFileDictIO, enabling standardized reading and writing of data records as dictionaries from CSV and MCF files.
- Comprehensive File Sharder: Developed FileSharder and a shard_file function that leverages the new FileDictIO classes to efficiently shard input files. It supports specifying a sharding key (e.g., a column name or property), determining shard counts dynamically, skipping duplicate records, and sampling input data.
- Enhanced File Utility: The FileIO class in file_util.py now exposes a get_file_handle method, which is utilized by the new FileDictIO classes.
- Improved Flag Parsing: A minor but important fix in mcf_diff.py ensures that absl.flags are properly parsed before accessing flag values, preventing potential runtime errors.
- Dedicated Test Coverage: New unit tests (file_dict_io_test.py and file_sharder_test.py) have been added to validate the functionality and correctness of the new file I/O and sharding utilities.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command>
or @gemini-code-assist <command>
. Below is a summary of the supported commands.
Feature | Command | Description |
---|---|---|
Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/
folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request introduces new utilities for sharding CSV and MCF files, a significant piece of new functionality. The implementation includes I/O helpers in file_dict_io.py
and the main sharding logic in file_sharder.py
, along with unit tests. The code is generally well-structured. However, I've identified a few issues that should be addressed, including potential runtime errors like an AttributeError
from an uninitialized variable and a ZeroDivisionError
. There are also some opportunities to improve code clarity and address module dependency issues related to sys.path
manipulation.
tools/statvar_importer/mcf_diff.py
Outdated
@@ -127,7 +129,7 @@ def get_diff_config() -> dict: | |||
'compare_dcids': _FLAGS.compare_dcids, | |||
'compare_nodes_with_pv': _FLAGS.compare_nodes_with_pv, | |||
'show_diff_nodes_only': _FLAGS.show_diff_nodes_only, | |||
} | |||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
def __next__(self): | ||
"""Returns the next record from the file being read.""" | ||
return self.next() |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
def __next__(self): | ||
"""Returns the next record from the file being read.""" | ||
return self.next() |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Adds the following utilities to shard csv and mcf files:
This can be used to generate shards of smaller MCF files for differ or dc-import genmcf.
Using a key that groups observations by "{observationAbout}{variableMeasured}" allows stats checks for duplicate observations and time series holes with genmcf on a single csv shard.
For example, to shard processed CSVs for the next stages of file-wise genmcf and differ:
python file_sharder.py --shard_input=output/*.csv --shard_output=shard/[email protected] --shard_key="{observationAbout}{variableMeasured}"
This generates smaller files of the form
shard/sharded-output-0000?-of-00010.csv
that can be passed individually togenmcf and differ.