Skip to content

Docstrings Models#232

Merged
mali-git merged 26 commits intodocstringsfrom
docstrings_models
Aug 29, 2024
Merged

Docstrings Models#232
mali-git merged 26 commits intodocstringsfrom
docstrings_models

Conversation

@mali-git
Copy link
Copy Markdown
Member

@mali-git mali-git commented Aug 17, 2024 •
edited
Loading

What does this PR do?

This PR adds docstrings to all model related modules, enhancing code documentation and readability.

General Changes

Breaking Changes

  • None

Checklist before submitting final PR

  • My PR is minimal and addresses one issue in isolation
  • I have merged the latest version of the target branch into this feature branch
  • I have reviewed my own code w.r.t. correct implementation, missing type hints, proper documentation, etc.
  • I have run a sample config for model training
  • I have checked that all tests run through (python tests/tests.py)
  • I have updated the internal changelog (CHANGELOG_DEV.md)

flxst and others added 25 commits August 8, 2024 19:44
@flxst
chore: fix linting
bbff3c8
@le1nux
Merge pull request #214 from Modalities/fix/linting
44bfe4c 
Fix linting
@mali-git
docs: add docstring to model_factory.py
d72f4fe
@mali-git
docs: add docstrings to model.py
40d84b4
@mali-git
docs: add docstrings to utils.py
c628bc4
@mali-git
docs: add docstring to collator.py
b9ce832
@mali-git
docs: add docstrings to gpt2_model.py
aa19454
@mali-git
docs: add docstrings to pretrained_gpt_model.py
d90e504
@mali-git
docs: add docstrings to layer_norms.py
946e7e1
@mali-git
docs: add docstring to huggingface_model.py
ffdbdad
@mali-git
docs: add docstrings to hf_adapter.py
5809843
@mali-git
docs: add docstring to layernorm.py
053f19a
@mali-git
docs: add docstring to selective_state_update.py
154c13e
@mali-git
docs: add docstring to selective_scan_interface.py
f1ebed3
@mali-git
docs: add docstrings to generation.py
88ba4f5
@mali-git
docs: add docstrings to mamba_block.py
b80b8b2
@mali-git
docs: add docstrings to mamba_config.py
8a7c14c
@mali-git
docs: add docstring to mamba_model.py
594a09c
@mali-git
docs: fix optional arguments in docstrings
f065415
@mali-git
docs: add docstrings to vision_transformer_model.py
f3984d9
@mali-git
docs: add docstrings to attention_pooling.py
ca21e77
@mali-git
docs: add docstrings to coca_model.py
de92cac
@mali-git
docs: add docstrings to collator.py
b12e913
@mali-git
docs: add docstring to multi_modal_decoder.py
5861caa
@mali-git
docs: add docstrings to text_decoder.py
d2fda5d
@mali-git mali-git requested a review from flxst August 17, 2024 10:34
@mali-git mali-git added the documentation Improvements or additions to documentation label Aug 17, 2024
@mali-git mali-git changed the title Docstrings models Docstrings odels Aug 17, 2024
@mali-git mali-git changed the title Docstrings odels Docstrings Models Aug 17, 2024
flxst
flxst approved these changes Aug 29, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@flxst flxst left a comment

Choose a reason for hiding this comment

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

Added many suggestions for minor improvements

Comment thread src/modalities/models/coca/attention_pooling.py Outdated
Comment thread src/modalities/models/coca/coca_model.py Outdated
Comment thread src/modalities/models/coca/coca_model.py Outdated
Comment thread src/modalities/models/coca/coca_model.py Outdated
Comment thread src/modalities/models/coca/coca_model.py Outdated
Comment thread src/modalities/models/mamba/utils/generation.py
Comment thread src/modalities/models/vision_transformer/vision_transformer_model.py Outdated
Comment thread src/modalities/models/vision_transformer/vision_transformer_model.py Outdated
Comment thread src/modalities/models/vision_transformer/vision_transformer_model.py Outdated
Comment thread src/modalities/models/vision_transformer/vision_transformer_model.py Outdated
@mali-git @flxst
Apply suggestions from code review
a019940 
Co-authored-by: Felix Stollenwerk <felix.stollenwerk@ai.se>
@mali-git mali-git merged commit 573bf1b into docstrings Aug 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@flxst flxst flxst approved these changes

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@mali-git @flxst @le1nux