Functions — github.com/ZhouYanzhao/Nest

↓ 20 callersMethodadd_argument

Hide metavar by default.

src/nest/cli.py:47

↓ 19 callersMethodkeys

(self)

src/nest/modules.py:40

↓ 15 callersMethoditems

(self)

src/nest/modules.py:37

↓ 7 callersMethod_update_modules

Automatically import all available Nest modules.

src/nest/modules.py:691

↓ 5 callersMethodclone

Clone the Nest module. Parameters: params: Module parameters

src/nest/modules.py:187

↓ 4 callersMethodload

(self)

src/nest/settings.py:118

↓ 3 callersFunctionis_variable

(name: str)

src/nest/parser.py:31

↓ 3 callersFunctionresolve_variable

(name: str)

src/nest/parser.py:34

↓ 3 callersMethodsave

(self)

src/nest/settings.py:121

↓ 3 callersMethodsave_settings

Save Nest settings. Parameters: path: Path to the setting file settings: The

src/nest/settings.py:58

↓ 3 callersMethodvalues

(self)

src/nest/modules.py:43

↓ 2 callersMethod_check_params

Raise errors if invalid params are provided to the Nest module. Parameters: params: The provided params

src/nest/modules.py:95

↓ 2 callersMethod_import_nest_modules_from_dir

Import registered Nest modules form a given directory. Parameters: path: The path to the directory n

src/nest/modules.py:382

↓ 2 callersMethod_import_nest_modules_from_file

Import registered Nest modules form a given file. Parameters: path: The path to the file namespace:

src/nest/modules.py:302

↓ 2 callersMethod_install_namespaces_from_path

Install namespaces from path. Parameters: path: Path to the directory namespace: Spec

src/nest/modules.py:535

↓ 2 callersMethod_update_namespaces

Get the available namespaces.

src/nest/modules.py:668

↓ 2 callersFunctioncheck_all_resolved

(resolved_config: Any)

src/nest/parser.py:91

↓ 2 callersMethodhook_exceptions

Format excetion traceback. Parameters: logger: The logger for logging exceptions.

src/nest/cli.py:73

↓ 2 callersFunctionparse_config

Parse experiment config. Parameters: config: The configuration of Nest modules, which specifies initial parameters, topologie

src/nest/parser.py:13

↓ 1 callersMethod__init__

(self, func: Callable, meta: Dict[str, object], params: dict = {})

src/nest/modules.py:56

↓ 1 callersMethod__len__

Number of Nest modules Returns: The number of Nest modules

src/nest/modules.py:712

↓ 1 callersMethod_add_module_finder

Add a custom finder to support Nest module import syntax.

src/nest/modules.py:635

↓ 1 callersMethod_check_definition

Raise errors if the module definition is invalid.

src/nest/modules.py:74

↓ 1 callersMethod_check_returns

Raise errors if invalid returns are generated by the Nest module. Parameters: returns: The generated returns

src/nest/modules.py:124

↓ 1 callersMethod_fetch_nest_modules_from_url

Fetch and unzip Nest modules from url. Parameters: url: URL of the zip file or git repo dst:

src/nest/modules.py:413

↓ 1 callersMethod_format_namespace

Format namespace. Parameters: src: The original namespace Returns: Formatted namespa

src/nest/modules.py:214

↓ 1 callersMethod_import_nest_modules_from_py_module

Import registered Nest modules from a given python module. Parameters: namespace: A namespace that is used to avo

src/nest/modules.py:270

↓ 1 callersMethod_install_namespaces_from_url

Install namespaces from url. Parameters: url: URL of the zip file or git repo namespace:

src/nest/modules.py:480

↓ 1 callersMethod_pack_namespaces

Pack namespaces to a zip file. Parameters: srcs: Path to the namespaces dst: Save pat

src/nest/modules.py:595

↓ 1 callersMethod_remove_namespaces_from_path

Remove namespaces from path. Parameters: src: Namespace or path

src/nest/modules.py:560

↓ 1 callersMethodexec_module

(self, module)

src/nest/modules.py:650

↓ 1 callersMethodfilter

(self, record: object)

src/nest/logger.py:14

↓ 1 callersMethodload_settings

Load Nest settings. Returns: The settings dict

src/nest/settings.py:77

↓ 1 callersFunctionmain

()

src/nest/__main__.py:3

↓ 1 callersFunctionrun_tasks

Run experiment tasks by resolving config. Parameters: config_file: The path to the config file param_file:

src/nest/parser.py:75

↓ 1 callersFunctionsetup_logger

Initialize logger. Returns: The global logger

src/nest/logger.py:18

Method__call__

(self, *args, **kwargs)

src/nest/modules.py:136

Method__contains__

(self, key)

src/nest/settings.py:115

Method__dir__

Support IDE auto-completion Returns: A list of module names

src/nest/modules.py:731

Method__getattr__

Get a Nest module by name. Parameters: key: Name of the Nest module Returns: The Ne

src/nest/modules.py:742

Method__getitem__

(self, key: str)

src/nest/modules.py:28

Method__getitem__

Get a Nest module by a query string. There are three match modes: 1. Exact match if the query string starts with '$':

src/nest/modules.py:769

Method__getitem__

(self, key: str)

src/nest/settings.py:109

Method__init__

(self)

src/nest/cli.py:61

Method__init__

(self)

src/nest/modules.py:202

Method__init__

(self)

src/nest/modules.py:654

Method__init__

(self)

src/nest/settings.py:106

Method__iter__

(self)

src/nest/modules.py:34

Method__iter__

Iterator for Nest modules. Returns: The Nest module iterator

src/nest/modules.py:702

Method__repr__

(self)

src/nest/modules.py:184

Method__repr__

(self)

src/nest/modules.py:825

Method__setitem__

(self, key: str, val: str)

src/nest/modules.py:31

Method__setitem__

(self, key: str, val: str)

src/nest/settings.py:112

Method__str__

(self)

src/nest/modules.py:177

Method__str__

(self)

src/nest/modules.py:828

Method_hook

(exc_type, value, exc_tb)

src/nest/cli.py:81

Method_hook

(count, block_size, total_size)

src/nest/modules.py:423

Method_ipython_key_completions_

Support IPython key completion. Returns: A list of module ids

src/nest/modules.py:722

Method_register

Decorator for Nest modules registration. Parameters: ignored: Ignore the module module meta informat

src/nest/modules.py:228

Functionalert_msg

Show alert message. Parameters: msg: The message

src/nest/utils.py:114

Methodcheck_extension

(filename)

src/nest/modules.py:614

Methodclear

(self)

src/nest/modules.py:46

Methodcmd_module

module Nest module manager.

src/nest/cli.py:123

Methodcmd_setting

setting Settings configuration.

src/nest/cli.py:236

Methodcmd_task

task Task runner.

src/nest/cli.py:99

Methodcreate_module

(func)

src/nest/modules.py:258

Methodcreate_module

(self, spec)

src/nest/modules.py:642

Functiondecode_id

Decode unique id to namespace and key. Parameters: unique_id: The given unique id Returns: namespace and key

src/nest/utils.py:96

Functionencode_id

Encode unique id from namespace and key. Parameters: namespace: The given namespace key: The given key

src/nest/utils.py:77

Methoderror

Show help when parse failed.

src/nest/cli.py:38

Functionexception

Decorator for logging errors and warnings of function. Parameters: func: The decorated function

src/nest/logger.py:47

Methodfind_requirement

(name)

src/nest/modules.py:352

Methodfind_spec

(self, fullname, path, target=None)

src/nest/modules.py:659

Functionformat_elapse

Format an elapse to human readable string. Parameters: elapse: The elapse dict, e.g., dict(seconds=10) Returns:

src/nest/utils.py:31

Methodformat_help

Allow to use custom help.

src/nest/cli.py:29

Functionindent_text

Indent multi-line text. Parameters: text: The input text indent: Number of spaces

src/nest/utils.py:64

Methodinstall_dep

(url, tool)

src/nest/modules.py:519

Functionis_annotation_matched

Return True if annotation is matched with the given variable. {Any, List, Set, Tuple, Dict, Union, Callable, Iterable, Iterator} from "typing" are

src/nest/utils.py:163

Functionload_yaml

Load yaml file. Parameters: path: The path to the file Returns: The dict Raw string

src/nest/utils.py:47

Functionmerge_dict

Recursively merges two dicts. Parameters: src: The source dict (will be modified) diff: Differences to

src/nest/utils.py:128

Methodonerror

(func, path, exc_info)

src/nest/cli.py:201

Functionwrapper

(*args, **kwargs)

src/nest/logger.py:55

Functionyaml_format

Format dict using YAML. Parameters: obj: The input dict object Returns: formated string

src/nest/utils.py:17

Functions83 in github.com/ZhouYanzhao/Nest