Skip to content

Refactor ColPali model documentation#37309

Merged
stevhliu merged 6 commits intohuggingface:mainfrom
Soum-Soum:refactor-colpali-model-doc
Apr 15, 2025
Merged

Refactor ColPali model documentation#37309
stevhliu merged 6 commits intohuggingface:mainfrom
Soum-Soum:refactor-colpali-model-doc

Conversation

@Soum-Soum
Copy link
Copy Markdown
Contributor

What does this PR do?

As suggested in this issue - #36979 - this PR updates the documentation of the ColPali model, which will now be aligned with the standardized format for all the docs.

Who can review?

@stevhliu, please let me know if any changes are needed.

@github-actions github-actions Bot marked this pull request as draft April 5, 2025 19:45
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 5, 2025

Hi 👋, thank you for opening this pull request! The pull request is converted to draft by default. The CI will be paused while the PR is in draft mode. When it is ready for review, please click the Ready for review button (at the bottom of the PR page). This will assign reviewers and trigger CI.

@Soum-Soum Soum-Soum marked this pull request as ready for review April 5, 2025 19:48
@github-actions github-actions Bot requested a review from stevhliu April 5, 2025 19:49
Copy link
Copy Markdown
Member

@stevhliu stevhliu left a comment

Choose a reason for hiding this comment

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

Very nice summary! 👏

Comment thread docs/source/en/model_doc/colpali.md Outdated
Comment thread docs/source/en/model_doc/colpali.md Outdated
Comment thread docs/source/en/model_doc/colpali.md Outdated
Comment thread docs/source/en/model_doc/colpali.md Outdated
Comment thread docs/source/en/model_doc/colpali.md Outdated
Comment thread docs/source/en/model_doc/colpali.md Outdated
Comment thread docs/source/en/model_doc/colpali.md
Soum-Soum and others added 2 commits April 7, 2025 23:16
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
@Soum-Soum
Copy link
Copy Markdown
Contributor Author

@stevhliu I've made a pass on your feedback. Let me know if you see some new things to change/improve.

Copy link
Copy Markdown
Member

@stevhliu stevhliu left a comment

Choose a reason for hiding this comment

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

One last suggestion to simplify things a bit more, then we can merge! 🤗

Comment thread docs/source/en/model_doc/colpali.md Outdated
Comment thread docs/source/en/model_doc/colpali.md Outdated
@HuggingFaceDocBuilderDev
Copy link
Copy Markdown

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.

Copy link
Copy Markdown
Member

@stevhliu stevhliu left a comment

Choose a reason for hiding this comment

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

Thanks!

@stevhliu stevhliu merged commit 3165eb7 into huggingface:main Apr 15, 2025
10 checks passed
cyr0930 pushed a commit to cyr0930/transformers that referenced this pull request Apr 18, 2025
* Refactor ColPali model documentation

* Apply suggestions from code review

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

* Include quantisation exemple + real images

* simpler image loading

---------

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
zucchini-nlp pushed a commit to zucchini-nlp/transformers that referenced this pull request May 14, 2025
* Refactor ColPali model documentation

* Apply suggestions from code review

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

* Include quantisation exemple + real images

* simpler image loading

---------

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
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.

3 participants