kudzu package
Subpackages
Submodules
kudzu.callbacks module
kudzu.data module
kudzu.example module
- class kudzu.example.Example(init_value: int = 10)[source]
Bases:
object
This is an example object. Use this example for ideas on how to write doc strings, use logging, construct objects. This is not an exhaustive example but a decent start.
- Parameters
init_value (int) – An integer value to initialize the object with.
- get_previous_value() int [source]
Get the previous value.
- Returns
previous_value – The previous value stored in the object.
- Return type
int
- get_value() int [source]
Get the current value.
- Returns
current_value – The current value stored in the object.
- Return type
int
- update_value(new_value: int) int [source]
Save old value and set new value.
- Parameters
new_value (int) – The new value to assign to the object.
- Returns
old_value – The previous value stored in the object.
- Return type
int
- property values: Tuple[int]
Get both values stored in the object as a tuple of integers.
- Returns
values – The current and old values stored in a tuple in (current_value, old_value) order.
- Return type
Tuple[int]
kudzu.function module
kudzu.loss module
kudzu.optim module
kudzu.train module
Module contents
Top-level package for Kudzu.