search

marius-team / marius

Large scale graph learning on a single machine.
https://marius-project.org
Apache License 2.0
160 stars 45 forks source link

Add comments for preprocess module #65

Closed AnzeXie closed 2 years ago

AnzeXie commented 3 years ago

Describe the pull request

This pull request adds docstrings to preprocess.py and csv_converter.py to enhance the readability of the codes. The docstrings added follow PEP 257 and Google Python Style Guide (https://github.com/google/styleguide/blob/gh-pages/pyguide.md#s3.8.1-comments-in-doc-strings).

This pull request also adds a download_directory option for users to choose which directory to store the downloaded dataset files. By default, the value of this option is "download_dir". Related documents are also updated.

How was this tested? Docs and comments were inspected manually. The option of download_directory is tested by adding a new test in test_csv_preprocessor.py.

shivaram commented 3 years ago

cc @thodrek