beamds.beam package#

Subpackages#

Submodules#

beamds.beam.meta module#

class beamds.beam.meta.BeamName(name=None, dynamic_name=True, **kwargs)[source]#

Bases: object

property beam_class_name#
property name#
set_name(name)[source]#
class beamds.beam.meta.MetaBeamInit[source]#

Bases: type

beamds.beam.resources module#

beamds.beam.resources.chdir(path)[source]#
beamds.beam.resources.cwd()[source]#
beamds.beam.resources.register_resource(scheme, generator)[source]#
beamds.beam.resources.resource(uri, **kwargs) → BeamResource | Any[source]#
beamds.beam.resources.this_dir()[source]#
beamds.beam.resources.this_file()[source]#

Module contents#

class beamds.beam.BeamConfig(*args, _store_init_path=None, _save_init_args=True, **kwargs)[source]#

Bases: Namespace

classmethod add_argument(name, type, default, help=None, tags=None)[source]#
classmethod add_arguments(*args)[source]#
property beam_class_name#
classmethod default_values()[source]#
defaults = {}#
dict()[source]#
classmethod from_path(path, ext=None)[source]#
get(key, default=None, specific=None)[source]#
property help#
is_hparam(key)[source]#
property is_initialized#
items()[source]#
keys()[source]#
property namespace#
parameters = [BeamParam(name='debug', type=<class 'bool'>, default=False, help='Whether to run in debug mode (logger is set to DEBUG level)', tags=None), BeamParam(name='colors', type=<class 'bool'>, default=True, help='Whether to use colors in the logger output', tags=None), BeamParam(name='beam-logs-path', type=<class 'str'>, default='/home/runner/beam_data/logs', help='Where to store the beam-logger output', tags=None)]#
pop(key, default=None)[source]#
classmethod remove_argument(name)[source]#
classmethod remove_arguments(*args)[source]#
set(key, value, tags=None)[source]#
classmethod set_default(name, value)[source]#
classmethod set_defaults(**kwargs)[source]#
property tags#
to_path(path, ext=None)[source]#
update(hparams, tags=None, exclude: Set | List = None)[source]#
static update_parser(parser, defaults=None, parameters=None, source=None)[source]#
values()[source]#