Type an introduction of the package here.
FileLike = Union[str, Path]
Floats = Union[float, Collection[float]]
AnnealingFt = Union[Callable[[float,float,float],float],Callable[[float,float,float,float],float]]
annealing_cos(start: float, end: float, pct: float) -> float
annealing_exp(start: float, end: float, pct: float) -> float
annealing_linear(start: float, end: float, pct: float) -> float
annealing_no(start: float, end: float, pct: float) -> float
annealing_poly(degree: float) -> Callable
do_annealing_poly(start: float, end: float, pct: float, degree: float) -> float
example_function(x: int, cls: Parentclass=None) -> str
Provides an example to how docstrings are resolved
x: Number to store
cls: Class string
return: Error string
is_iterable(x) -> bool
is_listy(x) -> bool
is_tuple(x) -> bool
linked_docstring_example(x: int, s: str=Hello) -> bool
Should link to example_function
example_function
listify(p=None, q=None) -> Collection
Makes p a list that looks like q
class Parentclass()
class SmoothenValue(beta: float)
To compute the moving average of values
SmoothenValue.add_value(self, val: float)
class Subclass(var: int=10) :: Inherits from (Parentclass)
Parentclass
Subclass.cmethod(x)
Subclass.remove(self)
Subclass.update(self)