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

Add parallel read #508

Closed
wants to merge 1 commit into from
Closed

Add parallel read #508

wants to merge 1 commit into from

Conversation

jan-janssen
Copy link
Member

@jan-janssen jan-janssen commented Nov 20, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced HDF5 file access to support concurrent reading during writing operations.
    • Transitioned Jupyter notebook to utilize the Flux kernel for HPC submissions, improving compatibility with job scheduling.
  • Bug Fixes

    • Updated code snippets in the notebook to reflect the correct backend for job submissions.

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

Copy link
Contributor

coderabbitai bot commented Nov 20, 2024

Walkthrough

The pull request introduces changes to two main files: executorlib/standalone/hdf.py and notebooks/2-hpc-submission.ipynb. In hdf.py, the load, get_output, and get_queue_id functions are modified to include the swmr=True parameter in the h5py.File context manager, enabling Single Writer Multiple Reader access for HDF5 files. In the Jupyter notebook, the kernel is updated from Python 3 (ipykernel) to Flux, and code snippets are adjusted to reflect this new backend for HPC submissions.

Changes

File Change Summary
executorlib/standalone/hdf.py Modified load, get_output, and get_queue_id functions to include swmr=True in h5py.File.
notebooks/2-hpc-submission.ipynb Updated kernel metadata to "Flux" and adjusted code snippets to use backend="flux_submission".

Possibly related PRs

🐰 In the meadow, we hop and play,
With files and kernels, bright as day.
SWMR brings a joyful cheer,
Flux now leads our HPC frontier!
Let's code and run, our tasks align,
In the world of rabbits, all is fine! 🌼


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (6)
executorlib/standalone/hdf.py (3)

42-42: SWMR mode enabled correctly, consider adding error handling

The addition of SWMR mode is appropriate for enabling parallel reads. However, consider adding error handling for cases where the file might still be in the process of being written.

-    with h5py.File(file_name, "r", swmr=True) as hdf:
+    try:
+        with h5py.File(file_name, "r", swmr=True) as hdf:
+            data_dict = {}
+            if "function" in hdf:
+                data_dict["fn"] = cloudpickle.loads(np.void(hdf["/function"]))
+            else:
+                raise TypeError("Function not found in HDF5 file.")
+            if "input_args" in hdf:
+                data_dict["args"] = cloudpickle.loads(np.void(hdf["/input_args"]))
+            else:
+                data_dict["args"] = ()
+            if "input_kwargs" in hdf:
+                data_dict["kwargs"] = cloudpickle.loads(np.void(hdf["/input_kwargs"]))
+            else:
+                data_dict["kwargs"] = {}
+            return data_dict
+    except OSError as e:
+        raise IOError(f"Error reading HDF5 file in SWMR mode: {e}")

77-77: Consider atomic operations for queue ID access

While SWMR mode is correctly implemented, accessing queue IDs in a parallel environment might need additional synchronization mechanisms to ensure consistency, especially if these IDs are used for job coordination.

Consider implementing a more robust queuing system (e.g., using a dedicated queue service or distributed lock) if queue IDs are critical for job coordination in your parallel processing workflow.


Line range hint 42-77: Document SWMR mode implications and requirements

The implementation of SWMR mode across all read operations is consistent and aligns with the parallel read objective. However, consider adding documentation about:

  1. The HDF5 version requirements for SWMR
  2. Performance implications of SWMR mode
  3. Limitations and constraints (e.g., file system requirements)
  4. Error handling recommendations for concurrent access scenarios
notebooks/2-hpc-submission.ipynb (3)

Line range hint 69-69: Update code examples in documentation

The markdown cells contain code examples still using backend="slurm_submission", but the notebook has moved to using Flux. Please update these examples to use backend="flux_submission" for consistency.

Also applies to: 77-77, 83-83


Line range hint 2-5: LGTM! Consider adding performance comparison

The examples effectively demonstrate the transition to Flux backend. Consider adding a performance comparison section between SLURM and Flux for common operations to help users understand the benefits of each approach.

Also applies to: 73-77


Line range hint 1009-1009: Enhance cache cleanup robustness

The cache cleanup implementation could be improved:

  1. Add specific error handling for different failure scenarios
  2. Add logging for cleanup operations
  3. Consider implementing a cleanup policy (e.g., based on age or size)
 if os.path.exists(cache_dir):
     print(os.listdir(cache_dir))
     try:
         shutil.rmtree(cache_dir)
-    except OSError:
-        pass
+    except PermissionError as e:
+        print(f"Permission error while cleaning cache: {e}")
+    except FileNotFoundError as e:
+        print(f"Cache directory not found: {e}")
+    except OSError as e:
+        print(f"Error cleaning cache: {e}")
+    else:
+        print(f"Successfully cleaned cache directory: {cache_dir}")
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between c0d3642 and 2828b2a.

📒 Files selected for processing (2)
  • executorlib/standalone/hdf.py (2 hunks)
  • notebooks/2-hpc-submission.ipynb (1 hunks)
🔇 Additional comments (2)
executorlib/standalone/hdf.py (1)

69-69: Verify SWMR behavior with concurrent writes

The SWMR mode is correctly implemented. However, please verify that the output reading behavior works as expected when the output dataset is being written concurrently.

notebooks/2-hpc-submission.ipynb (1)

1-1: Verify Flux kernel setup requirements

The notebook now requires the Flux kernel instead of the standard Python kernel. Please ensure:

  1. Documentation is updated to include Flux kernel setup instructions
  2. CI/CD pipelines are updated to support the Flux kernel

@jan-janssen jan-janssen deleted the parallel_read branch November 20, 2024 14:12
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.

1 participant