SforAiDl / vformer

A modular PyTorch library for vision transformer models
https://vformer.readthedocs.io/
MIT License
162 stars 22 forks source link

Improving documentation #100

Closed abhi-glitchhg closed 1 year ago

abhi-glitchhg commented 1 year ago

Opening as a draft.

improving documentation. Also added workflow for Document compilation.

codecov-commenter commented 1 year ago

Codecov Report

Merging #100 (c51c7a0) into main (6da7080) will not change coverage. The diff coverage is 100.00%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #100 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 66 66 Lines 1972 1970 -2 ========================================= - Hits 1972 1970 -2 ``` | [Impacted Files](https://codecov.io/gh/SforAiDl/vformer/pull/100?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=SforAiDl) | Coverage Δ | | |---|---|---| | [vformer/attention/convvt.py](https://codecov.io/gh/SforAiDl/vformer/pull/100/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=SforAiDl#diff-dmZvcm1lci9hdHRlbnRpb24vY29udnZ0LnB5) | `100.00% <ø> (ø)` | | | [vformer/attention/cross.py](https://codecov.io/gh/SforAiDl/vformer/pull/100/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=SforAiDl#diff-dmZvcm1lci9hdHRlbnRpb24vY3Jvc3MucHk=) | `100.00% <ø> (ø)` | | | [vformer/attention/gated\_positional.py](https://codecov.io/gh/SforAiDl/vformer/pull/100/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=SforAiDl#diff-dmZvcm1lci9hdHRlbnRpb24vZ2F0ZWRfcG9zaXRpb25hbC5weQ==) | `100.00% <ø> (ø)` | | | [vformer/attention/memory\_efficient.py](https://codecov.io/gh/SforAiDl/vformer/pull/100/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=SforAiDl#diff-dmZvcm1lci9hdHRlbnRpb24vbWVtb3J5X2VmZmljaWVudC5weQ==) | `100.00% <ø> (ø)` | | | [vformer/attention/vanilla.py](https://codecov.io/gh/SforAiDl/vformer/pull/100/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=SforAiDl#diff-dmZvcm1lci9hdHRlbnRpb24vdmFuaWxsYS5weQ==) | `100.00% <ø> (ø)` | | | [vformer/attention/window.py](https://codecov.io/gh/SforAiDl/vformer/pull/100/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=SforAiDl#diff-dmZvcm1lci9hdHRlbnRpb24vd2luZG93LnB5) | `100.00% <ø> (ø)` | | | [vformer/common/base\_model.py](https://codecov.io/gh/SforAiDl/vformer/pull/100/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=SforAiDl#diff-dmZvcm1lci9jb21tb24vYmFzZV9tb2RlbC5weQ==) | `100.00% <ø> (ø)` | | | [vformer/common/blocks.py](https://codecov.io/gh/SforAiDl/vformer/pull/100/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=SforAiDl#diff-dmZvcm1lci9jb21tb24vYmxvY2tzLnB5) | `100.00% <ø> (ø)` | | | [vformer/decoder/perceiver\_io.py](https://codecov.io/gh/SforAiDl/vformer/pull/100/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=SforAiDl#diff-dmZvcm1lci9kZWNvZGVyL3BlcmNlaXZlcl9pby5weQ==) | `100.00% <ø> (ø)` | | | [vformer/encoder/convit.py](https://codecov.io/gh/SforAiDl/vformer/pull/100/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=SforAiDl#diff-dmZvcm1lci9lbmNvZGVyL2NvbnZpdC5weQ==) | `100.00% <ø> (ø)` | | | ... and [27 more](https://codecov.io/gh/SforAiDl/vformer/pull/100/diff?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=SforAiDl) | |