Update bamba model card

[druvdub]

What does this PR do?

Updates bamba model card for #36979

Before submitting

• This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
• Did you read the contributor guideline,
  Pull Request section?
• Was this discussed/approved via a Github issue or the forum? Please add a link
  to it if that's the case. [Community contributions] Model cards #36979
• Did you make sure to update the documentation with your changes? Here are the
  documentation guidelines, and
  here are tips on formatting docstrings.
• Did you write any new necessary tests?

Who can review?

@stevhliu

[druvdub]

Just a couple questions here as well. So far, I have basically mapped the content from previous format to current one + added some information about quantization.

Is there a way to potentially know if a model can be used with the pipeline API or the cli command? Or can I just expect that a model might support all 3 methods or whatever it has in its documentation?

I tried running the Bamba model using pipeline but kept on getting memory issues, so I am not sure if it can be run using the pipeline API or not.

[stevhliu]

Thanks! 🤗

[stevhliu]

Is there a way to potentially know if a model can be used with the pipeline API or the cli command? Or can I just expect that a model might support all 3 methods or whatever it has in its documentation?

In general, I think most models should work with the Pipeline API. For example, there is a BambaForCausalLM class and the TextGenerationPipeline says it supports any models with the ModelForCausalLM head.

For the cli command, it only takes text inputs so it doesn't support audio, vision, or multimodal inputs.

[druvdub]

@stevhliu This should be sorted now hopefully, other than just clarifying transformers vs transformers-cli

Also, could you please clarify what this CI check refers to

Repository-wide checks:
    - checking all models are included.
    - checking all models are public.
    - checking all models have tests.
    - checking all objects have documentation.
Traceback (most recent call last):
  File "/root/transformers/utils/check_repo.py", line 1269, in <module>
    check_repo_quality()
  File "/root/transformers/utils/check_repo.py", line 1253, in check_repo_quality
    check_all_objects_are_documented()
  File "/root/transformers/utils/check_repo.py", line 1130, in check_all_objects_are_documented
    raise Exception(
Exception: The following objects are in the public init, but not in the docs:
 - BambaModel

Exited with code exit status 1

Is this because its looking for the mention of BambaModel which usually comes under BambaConfig?

[stevhliu]

Thanks for all your work on this!

I'm not too sure about the CI message. Can you try adding the following to the doc after ## BambaConfig?

## BambaModel

[[autodoc]] BambaModel

[druvdub]

Thanks for all your work on this!

I'm not too sure about the CI message. Can you try adding the following to the doc after ## BambaConfig?

## BambaModel

[[autodoc]] BambaModel

Ah, that fixed the issue. The class had an auto_docstring annotation. Should be fine now! 🤗

[HuggingFaceDocBuilderDev]

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

[stevhliu]

LGTM and big thanks! 🤗