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 missing import guards for causal_conv1d and mamba_ssm dependencies #10429

Merged
merged 6 commits into from
Sep 17, 2024

Conversation

janekl
Copy link
Collaborator

@janekl janekl commented Sep 9, 2024

What does this PR do ?

Currently causal_conv1d and mamba_ssm are in fact required to use NeMo but are not included in requirements. This MR introduces the "import guard" mechanism for these two packages so that users that setup NeMo using pip install nemo-toolkit are not immediately hit by missing dependency problems if their use case is not related to Griffin or Mamba models.

Collection: NLP

Changelog

  • Add specific line by line info of high level changes in this PR.

Usage

  • You can potentially add a usage example below
# Add a code snippet demonstrating how to use this 

GitHub Actions CI

The Jenkins CI system has been replaced by GitHub Actions self-hosted runners.

The GitHub Actions CI will run automatically when the "Run CICD" label is added to the PR.
To re-run CI remove and add the label again.
To run CI on an untrusted fork, a NeMo user with write access must first click "Approve and run".

Before your PR is "Ready for review"

Pre checks:

  • Make sure you read and followed Contributor guidelines
  • Did you write any new necessary tests?
  • Did you add or update any necessary documentation?
  • Does the PR affect components that are optional to install? (Ex: Numba, Pynini, Apex etc)
    • Reviewer: Does the PR have correct import guards for all optional libraries?

PR Type:

  • New Feature
  • Bugfix
  • Documentation

If you haven't finished some of the above items you can still open "Draft" PR.

Who can review?

Anyone in the community is free to review the PR once the checks have passed.
Contributor guidelines contains specific people who can review PRs to various areas.

Additional Information

  • Related to # (issue)

@janekl janekl requested a review from JRD971000 September 9, 2024 11:32
@github-actions github-actions bot added the NLP label Sep 9, 2024
@janekl janekl added the Run CICD label Sep 9, 2024
@janekl janekl added Run CICD and removed Run CICD labels Sep 9, 2024
Copy link
Collaborator

@JRD971000 JRD971000 left a comment

Choose a reason for hiding this comment

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

LGTM!

@janekl janekl force-pushed the jlasek/missing_import_guards branch from 0e61cda to 1d71a0a Compare September 9, 2024 16:28
@janekl janekl added Run CICD and removed Run CICD labels Sep 9, 2024
janekl and others added 3 commits September 10, 2024 10:05
Signed-off-by: Jan Lasek <janek.lasek@gmail.com>
Signed-off-by: Jan Lasek <janek.lasek@gmail.com>
Signed-off-by: janekl <janekl@users.noreply.github.com>
@janekl janekl force-pushed the jlasek/missing_import_guards branch from 1d71a0a to 151498f Compare September 10, 2024 08:05
@janekl janekl added Run CICD and removed Run CICD labels Sep 10, 2024
@janekl janekl merged commit df3575a into main Sep 17, 2024
199 of 300 checks passed
@janekl janekl deleted the jlasek/missing_import_guards branch September 17, 2024 10:00
ko3n1g pushed a commit that referenced this pull request Sep 17, 2024
#10429)

* Add causal_conv1d import guard

Signed-off-by: Jan Lasek <janek.lasek@gmail.com>

* Add mamba_ssm import guard

Signed-off-by: Jan Lasek <janek.lasek@gmail.com>

* Apply isort and black reformatting

Signed-off-by: janekl <janekl@users.noreply.github.com>

---------

Signed-off-by: Jan Lasek <janek.lasek@gmail.com>
Signed-off-by: janekl <janekl@users.noreply.github.com>
Co-authored-by: janekl <janekl@users.noreply.github.com>
Co-authored-by: Pablo Garay <palenq@gmail.com>
gwarmstrong pushed a commit to gwarmstrong/NeMo that referenced this pull request Sep 19, 2024
NVIDIA#10429)

* Add causal_conv1d import guard

Signed-off-by: Jan Lasek <janek.lasek@gmail.com>

* Add mamba_ssm import guard

Signed-off-by: Jan Lasek <janek.lasek@gmail.com>

* Apply isort and black reformatting

Signed-off-by: janekl <janekl@users.noreply.github.com>

---------

Signed-off-by: Jan Lasek <janek.lasek@gmail.com>
Signed-off-by: janekl <janekl@users.noreply.github.com>
Co-authored-by: janekl <janekl@users.noreply.github.com>
Co-authored-by: Pablo Garay <palenq@gmail.com>
Signed-off-by: George Armstrong <georgea@nvidia.com>
ko3n1g added a commit that referenced this pull request Sep 26, 2024
#10429) (#10506)

* Add causal_conv1d import guard



* Add mamba_ssm import guard



* Apply isort and black reformatting



---------

Signed-off-by: Jan Lasek <janek.lasek@gmail.com>
Signed-off-by: janekl <janekl@users.noreply.github.com>
Co-authored-by: Jan Lasek <janek.lasek@gmail.com>
Co-authored-by: janekl <janekl@users.noreply.github.com>
Co-authored-by: Pablo Garay <palenq@gmail.com>
monica-sekoyan pushed a commit that referenced this pull request Oct 14, 2024
#10429)

* Add causal_conv1d import guard

Signed-off-by: Jan Lasek <janek.lasek@gmail.com>

* Add mamba_ssm import guard

Signed-off-by: Jan Lasek <janek.lasek@gmail.com>

* Apply isort and black reformatting

Signed-off-by: janekl <janekl@users.noreply.github.com>

---------

Signed-off-by: Jan Lasek <janek.lasek@gmail.com>
Signed-off-by: janekl <janekl@users.noreply.github.com>
Co-authored-by: janekl <janekl@users.noreply.github.com>
Co-authored-by: Pablo Garay <palenq@gmail.com>
tomlifu pushed a commit to tomlifu/NeMo that referenced this pull request Oct 25, 2024
NVIDIA#10429)

* Add causal_conv1d import guard

Signed-off-by: Jan Lasek <janek.lasek@gmail.com>

* Add mamba_ssm import guard

Signed-off-by: Jan Lasek <janek.lasek@gmail.com>

* Apply isort and black reformatting

Signed-off-by: janekl <janekl@users.noreply.github.com>

---------

Signed-off-by: Jan Lasek <janek.lasek@gmail.com>
Signed-off-by: janekl <janekl@users.noreply.github.com>
Co-authored-by: janekl <janekl@users.noreply.github.com>
Co-authored-by: Pablo Garay <palenq@gmail.com>
Signed-off-by: Lifu Zhang <tomzhanglf@gmail.com>
tomlifu pushed a commit to tomlifu/NeMo that referenced this pull request Oct 25, 2024
NVIDIA#10429)

* Add causal_conv1d import guard

Signed-off-by: Jan Lasek <janek.lasek@gmail.com>

* Add mamba_ssm import guard

Signed-off-by: Jan Lasek <janek.lasek@gmail.com>

* Apply isort and black reformatting

Signed-off-by: janekl <janekl@users.noreply.github.com>

---------

Signed-off-by: Jan Lasek <janek.lasek@gmail.com>
Signed-off-by: janekl <janekl@users.noreply.github.com>
Co-authored-by: janekl <janekl@users.noreply.github.com>
Co-authored-by: Pablo Garay <palenq@gmail.com>
Signed-off-by: Lifu Zhang <tomzhanglf@gmail.com>
hainan-xv pushed a commit to hainan-xv/NeMo that referenced this pull request Nov 5, 2024
NVIDIA#10429)

* Add causal_conv1d import guard

Signed-off-by: Jan Lasek <janek.lasek@gmail.com>

* Add mamba_ssm import guard

Signed-off-by: Jan Lasek <janek.lasek@gmail.com>

* Apply isort and black reformatting

Signed-off-by: janekl <janekl@users.noreply.github.com>

---------

Signed-off-by: Jan Lasek <janek.lasek@gmail.com>
Signed-off-by: janekl <janekl@users.noreply.github.com>
Co-authored-by: janekl <janekl@users.noreply.github.com>
Co-authored-by: Pablo Garay <palenq@gmail.com>
Signed-off-by: Hainan Xu <hainanx@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants