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

doc: update doc for mixed:N batch size #3780

Merged
merged 1 commit into from
May 14, 2024

Conversation

CaRoLZhangxy
Copy link
Collaborator

@CaRoLZhangxy CaRoLZhangxy commented May 14, 2024

#3474

Summary by CodeRabbit

  • Documentation
    • Updated the description of the "mixed:N" string option in the training data arguments to reflect that the "se_atten" descriptor is now supported only for the Tensorflow backend.

Copy link

coderabbitai bot commented May 14, 2024

Walkthrough

Walkthrough

The recent update modifies the description of the "mixed:N" string option in the training_data_args() function within the deepmd/utils/argcheck.py file. This change specifically restricts the support for the "se_atten" descriptor to only the Tensorflow backend, ensuring that users are aware of this limitation when configuring their training data.

Changes

File Path Change Summary
deepmd/utils/argcheck.py Updated the description of the "mixed:N" string option in training_data_args() to limit "se_atten" descriptor support to the Tensorflow backend.

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 33f00c8 and 06b3c78.
Files selected for processing (1)
  • deepmd/utils/argcheck.py (1 hunks)

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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

@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: 1

deepmd/utils/argcheck.py Show resolved Hide resolved
Copy link

codecov bot commented May 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.49%. Comparing base (33f00c8) to head (06b3c78).

Additional details and impacted files
@@           Coverage Diff           @@
##            devel    #3780   +/-   ##
=======================================
  Coverage   82.49%   82.49%           
=======================================
  Files         515      515           
  Lines       48642    48642           
  Branches     2980     2981    +1     
=======================================
  Hits        40126    40126           
  Misses       7605     7605           
  Partials      911      911           

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

@njzjz njzjz linked an issue May 14, 2024 that may be closed by this pull request
@njzjz njzjz enabled auto-merge May 14, 2024 19:31
@njzjz njzjz added this pull request to the merge queue May 14, 2024
Merged via the queue into deepmodeling:devel with commit 2bf0769 May 14, 2024
60 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] pt: setting batch_size to mixed:N throws errors
2 participants