Finegrain/refiners
1
0
Fork 0
mirror of https://github.com/finegrain-ai/refiners.git synced 2024-11-21 13:48:46 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

(doc/fluxion/converter) add/convert docstrings to mkdocstrings format

Browse source
This commit is contained in:
Laurent 2024-02-01 21:50:07 +00:00 committed by Laureηt
parent 6d09974b8d
commit fc824bd53d
1 changed files with 9 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
src/refiners/fluxion/layers/converter.py
View file

@ -7,18 +7,21 @@ class Converter(ContextModule):
"""
A Converter class that adjusts tensor properties based on a parent module's settings.
This class inherits from `ContextModule` and provides functionality to adjust
the device and dtype of input tensor(s) to match the parent module's attributes.
Attributes:
set_device (bool): If True, matches the device of the input tensor(s) to the parent's device.
set_dtype (bool): If True, matches the dtype of the input tensor(s) to the parent's dtype.
This class inherits from [`ContextModule`][refiners.fluxion.layers.ContextModule]
and provides functionality to adjust the device and dtype
of input tensor(s) to match the parent module's attributes.
Note:
Ensure the parent module has `device` and `dtype` attributes if `set_device` or `set_dtype` are set to True.
"""
def __init__(self, set_device: bool = True, set_dtype: bool = True) -> None:
"""Initializes the Converter layer.
Args:
set_device: If True, matches the device of the input tensor(s) to the parent's device.
set_dtype: If True, matches the dtype of the input tensor(s) to the parent's dtype.
"""
super().__init__()
self.set_device = set_device
self.set_dtype = set_dtype