Skip to content

Fix typo and inconsistency in the roxygen2 documentation#302

Merged
cregouby merged 15 commits intomlverse:mainfrom
DerrickUnleashed:taskmedium1
Mar 28, 2026
Merged

Fix typo and inconsistency in the roxygen2 documentation#302
cregouby merged 15 commits intomlverse:mainfrom
DerrickUnleashed:taskmedium1

Conversation

@DerrickUnleashed
Copy link
Copy Markdown
Contributor

Fixed some typos:

  • desease -> disease
  • class_too_idx -> class_to_idx

Fixed model documentation inconsistencies by aligning them with the documentation that was requested during previous model creations:

  • DeeplabV3
  • ConvNext Detection

Other model documentations can also be aligned using the same metrics. However, I am pausing for now since the current tasks are complete and I will continue this work during the GSoC period.

Copy link
Copy Markdown
Collaborator

@cregouby cregouby left a comment

Choose a reason for hiding this comment

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

praise thanks a lot for the typos and for the model documentation improvement.
todo there are some revertion to do on the models documentation (see inline comments)

Comment thread R/models-convnext_detection.R Outdated
Comment thread R/models-convnext_detection.R Outdated
Comment thread R/models-convnext_detection.R Outdated
Comment thread R/models-deeplabv3.R Outdated
Comment thread R/models-deeplabv3.R
Comment thread R/models-deeplabv3.R Outdated
Comment thread R/models-deeplabv3.R Outdated
Comment thread R/models-deeplabv3.R
@DerrickUnleashed
Copy link
Copy Markdown
Contributor Author

DerrickUnleashed commented Mar 22, 2026

Thanks for the inline comments. I have now run check(), and it is successful.

Some doubts arise,

  • @importFrom torch nn_module is used in some models like models-deeplabv3.R however, it is not present in the other models like models-convnext-segmentation.R. Is it necessary for it to be present in all models that use torch::nn_module()? If so, I can make the necessary updates required.
  • A lot of commands in the code base utilise torch::. Can we remove it since torchvision is present in torch ?
    Eg : torch::nn_module() -> nn_module().

Other Changes Incorporated:

  • changed from magick_loader() to base_loader() to use the efficiency of JPEG:: and PNG::

@cregouby cregouby merged commit 77890ef into mlverse:main Mar 28, 2026
3 checks passed
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.

2 participants