Update Docstrings

[guarin]

Description

Go through all PIP modules and make sure that the docstrings are consistently formatted and complete.

• We only care about public functions/classes/methods for now (things that are in the Python API Docs).
• We don't care about outdated/deprecated modules such as active_learning and the high level models.

This is an example of a well documented file: https://github.com/lightly-ai/lightly/blob/master/lightly/models/modules/memory_bank.py

When updating docstrings or comments keep the following in mind:

• Follow the google python styleguide: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings
• Do not document default values if they are part of the function definition. E.g. if the function is defined as: def fun(value: int = 5) there is no need to document that 5 is the default for value in the docstring. It is already visible in the function definition. However, if the function is defined as def fun(value: int | None = None) and in the code we do: if value is None: value = 5 we should document that value is set to 5 by default as this is not evident from the function definition.
• Make full sentences when writing comments
• Do not add comments if it is evident from the code what is happening

How to work on this issue

1. Take any file from one of the modules listed below
2. Make sure that all public functions/classes/methods are well documented. You can also split the work into multiple PRs for files with many functions or classes with many methods.
3. Add documentation if necessary
4. Create a PR named "Add documentation for " and push your changes

Tasks

• Figure out if we can use tool to verify docstring format #1217
• Cleanup transforms docstrings #1223
• Cleanup docstrings in lightly/loss subpackage. #1673
• Cleanup docstrings in lightly/models/modules subpackage. #1687
• Cleanup docstrings in lightly/models/utils.py #1663
• Cleanup docstrings in lightly/data subpackage #1674
• Cleanup docstrings in lightly/utils subpackage. #1675
• Cleanup docstrings in lightly/embedding subpackage. #1670

[ayush22iitbhu]

@guarin Is this issue resolved? If not then please assign it to me. I would love to work on this.

[guarin]

Hi and thanks for working on this! Could you quickly indicate on which files you would work?

[ayush22iitbhu]

lightly/models/utils.py

[guarin]

Awesome, created the issue for you: #1663 If you comment on it I can assign it to you.

[Prathamesh010]

Please create a issue for Cleanup docstrings in lightly/embedding subpackage and assign it to me. @guarin

[guarin]

Please create a issue for Cleanup docstrings in lightly/embedding subpackage and assign it to me. @guarin

Created the issue, if you comment on it I'll be able to assign it to you

[ayush22iitbhu]

@guarin I want to work on lightly/loss subpackage, lightly/data subpackage, and lightly/utils subpackage. Please assign it to me.

[guarin]

@ayush22iitbhu I created the issue, I can assign it to you if you comment on it. #1673

I'll keep the others unassigned for now.

[fadkeabhi]

@guarin I want to work on lightly/models/modules subpackage. Can you assign it to me.

[guarin]

Awesome, can you comment on the issue #1687 then I can assign it to you