Update submission.py

[yzhong52]

Cleanup some unused comments

Summary by CodeRabbit

• New Features

  • Enhanced submission state recovery through improved JSON handling.
  • Improved job state management with refined error handling and logging.

• Bug Fixes

  • Updated methods to better manage unexpected job states.

• Documentation

  • Clarified method signatures and functionality in the Submission and Job classes for better understanding.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes involve significant updates to the Submission, Job, and Resources classes within the dpdispatcher/submission.py file. The Submission class constructor now accepts task_list as a keyword-only argument, and the submission_list attribute has been removed. Modifications to the serialize and deserialize methods enhance data handling and recovery mechanisms. The Job class constructor now calculates job_hash upon initialization, and the Resources class has updated logic for parameter validation. Overall, these modifications improve the structure and functionality of the submission and job management system.

Changes

File

Change Summary

dpdispatcher/submission.py

- Updated Submission constructor to use task_list as a keyword-only argument and removed submission_list attribute. - Enhanced serialize method to include _abs_work_base. - Modified deserialize method for flexible handling of machine. - Improved try_recover_from_json for submission state recovery. - Restructured run_submission for better job state management. - Updated async_run_submission to warn on clean=True. - Job constructor now calculates job_hash immediately. - Refined handle_unexpected_job_state for better error handling. - Updated Resources class to enforce constraints on if_cuda_multi_devices and validate ratio_unfinished.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Submission
    participant Job
    participant Resources

    User->>Submission: Create Submission with task_list
    Submission->>Job: Initialize Job with job_hash
    Submission->>Resources: Validate resources
    Submission->>Submission: Serialize and Deserialize
    Submission->>Submission: Run Submission
    Submission->>Job: Check job state
    Job->>Submission: Handle unexpected job state

Loading

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 819eddf and 6884d29.

📒 Files selected for processing (1)

• dpdispatcher/submission.py (0 hunks)

💤 Files with no reviewable changes (1)

• dpdispatcher/submission.py

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 47.78%. Comparing base (819eddf) to head (6884d29).
Report is 1 commits behind head on master.

❗ There is a different number of reports uploaded between BASE (819eddf) and HEAD (6884d29). Click for more details.

HEAD has 45 uploads less than BASE

Flag	BASE (819eddf)	HEAD (6884d29)
	59	14

Additional details and impacted files

@@             Coverage Diff             @@
##           master     #499       +/-   ##
===========================================
- Coverage   60.19%   47.78%   -12.42%     
===========================================
  Files          39       39               
  Lines        3859     3859               
===========================================
- Hits         2323     1844      -479     
- Misses       1536     2015      +479     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.