Skip to content

improve readme#665

Merged
yzhang123 merged 6 commits into
mainfrom
fix_bugs
Jan 30, 2025
Merged

improve readme#665
yzhang123 merged 6 commits into
mainfrom
fix_bugs

Conversation

@yzhang123
Copy link
Copy Markdown
Collaborator

@yzhang123 yzhang123 commented Jan 28, 2025

Description

Improve Readme and fix problems to the best of my knowledge, tested locally

Type of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Refactor
  • Documentation update
  • Other (please describe):

CI Pipeline Configuration

Configure CI behavior by applying the relevant labels:

Note

By default, the notebooks validation tests are skipped unless explicitly enabled.

Usage

TODO: Add code snippet

Pre-submit Checklist

  • I have tested these changes locally
  • I have updated the documentation accordingly
  • I have added/updated tests as needed
  • All existing tests pass successfully

Signed-off-by: Yang Zhang <yangzhang@nvidia.com>
@yzhang123
Copy link
Copy Markdown
Collaborator Author

/build-ci

@yzhang123 yzhang123 added documentation Improvements or additions to documentation SKIP_CI labels Jan 28, 2025
Copy link
Copy Markdown
Collaborator

@trvachov trvachov left a comment

Choose a reason for hiding this comment

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

Aside from small nitpick, looks good! thanks!

Comment thread README.md Outdated
@pstjohn
Copy link
Copy Markdown
Collaborator

pstjohn commented Jan 29, 2025

/build-ci

We don't actually need this anymore 😄

Comment thread README.md
@yzhang123 yzhang123 enabled auto-merge January 30, 2025 14:14
@yzhang123 yzhang123 added this pull request to the merge queue Jan 30, 2025
Merged via the queue into main with commit d3dd93e Jan 30, 2025
@yzhang123 yzhang123 deleted the fix_bugs branch January 30, 2025 16:36
sichu2023 pushed a commit that referenced this pull request Feb 10, 2025
### Description
Improve Readme and fix problems to the best of my knowledge, tested
locally

### Type of changes
<!-- Mark the relevant option with an [x] -->

- [x]  Bug fix (non-breaking change which fixes an issue)
- [ ]  New feature (non-breaking change which adds functionality)
- [x]  Refactor
- [x]  Documentation update
- [ ]  Other (please describe):

### CI Pipeline Configuration
Configure CI behavior by applying the relevant labels:

-
[SKIP_CI](https://github.com/NVIDIA/bionemo-framework/blob/main/docs/docs/user-guide/contributing/contributing.md#skip_ci)
- Skip all continuous integration tests
-
[INCLUDE_NOTEBOOKS_TESTS](https://github.com/NVIDIA/bionemo-framework/blob/main/docs/docs/user-guide/contributing/contributing.md#include_notebooks_tests)
- Execute notebook validation tests in pytest
-
[INCLUDE_SLOW_TESTS](https://github.com/NVIDIA/bionemo-framework/blob/main/docs/docs/user-guide/contributing/contributing.md#include_slow_tests)
- Execute tests labelled as slow in pytest for extensive testing

> [!NOTE]
> By default, the notebooks validation tests are skipped unless
explicitly enabled.

### Usage
<!--- How does a user interact with the changed code -->
```python
TODO: Add code snippet
```

### Pre-submit Checklist
<!--- Ensure all items are completed before submitting -->

 - [x] I have tested these changes locally
 - [x] I have updated the documentation accordingly
 - [ ] I have added/updated tests as needed
 - [ ] All existing tests pass successfully

---------

Signed-off-by: Yang Zhang <yangzhang@nvidia.com>
Signed-off-by: sichu <sichu@nvidia.com>
sichu2023 pushed a commit that referenced this pull request Feb 10, 2025
### Description
Improve Readme and fix problems to the best of my knowledge, tested
locally

### Type of changes
<!-- Mark the relevant option with an [x] -->

- [x]  Bug fix (non-breaking change which fixes an issue)
- [ ]  New feature (non-breaking change which adds functionality)
- [x]  Refactor
- [x]  Documentation update
- [ ]  Other (please describe):

### CI Pipeline Configuration
Configure CI behavior by applying the relevant labels:

-
[SKIP_CI](https://github.com/NVIDIA/bionemo-framework/blob/main/docs/docs/user-guide/contributing/contributing.md#skip_ci)
- Skip all continuous integration tests
-
[INCLUDE_NOTEBOOKS_TESTS](https://github.com/NVIDIA/bionemo-framework/blob/main/docs/docs/user-guide/contributing/contributing.md#include_notebooks_tests)
- Execute notebook validation tests in pytest
-
[INCLUDE_SLOW_TESTS](https://github.com/NVIDIA/bionemo-framework/blob/main/docs/docs/user-guide/contributing/contributing.md#include_slow_tests)
- Execute tests labelled as slow in pytest for extensive testing

> [!NOTE]
> By default, the notebooks validation tests are skipped unless
explicitly enabled.

### Usage
<!--- How does a user interact with the changed code -->
```python
TODO: Add code snippet
```

### Pre-submit Checklist
<!--- Ensure all items are completed before submitting -->

 - [x] I have tested these changes locally
 - [x] I have updated the documentation accordingly
 - [ ] I have added/updated tests as needed
 - [ ] All existing tests pass successfully

---------

Signed-off-by: Yang Zhang <yangzhang@nvidia.com>
Signed-off-by: sichu <sichu@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants