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

[2.4] Client API doc updates #2498

Merged
merged 7 commits into from
Apr 13, 2024

Conversation

chesterxgchen
Copy link
Collaborator

Description

Add additional documentations to explain different executor types, communication patterns (FilePipe vs CellPipe), choice of job templates etc.

Types of changes

  • Non-breaking change (fix or new feature that would not break existing functionality).
  • Breaking change (fix or new feature that would cause existing functionality to change).
  • New tests added to cover the changes.
  • Quick tests passed locally by running ./runtest.sh.
  • In-line docstrings updated.
  • Documentation updated.

SYangster
SYangster previously approved these changes Apr 12, 2024
SYangster
SYangster previously approved these changes Apr 13, 2024
Copy link
Collaborator

@YuanTingHsieh YuanTingHsieh left a comment

Choose a reason for hiding this comment

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

Mostly good, some feedbacks

@chesterxgchen chesterxgchen merged commit 9b84db1 into NVIDIA:2.4 Apr 13, 2024
15 checks passed
@chesterxgchen chesterxgchen deleted the 2.4_client_api_doc branch April 13, 2024 00: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.

None yet

3 participants