Common

Config

Search config file and get config information from config file.

Config file search order is described in following table. Each config value is overwritten by the following configs.

Type	Posix	Windows
System wide	/etc/nnabla.conf	c:\ProgramData\NNabla\nnabla.ini
User	~/.nnabla	c:\Users\[USERNAME]\AppData\Roaming\NNabla\nnabla.ini
Default	(Same directory with ‘config.py’)/nnabla.conf
Local	[CURRENT DIRECTORY]/nnabla.conf

You can get config value as followings.

from utils.config import nnabla_config
value = nnabla_config.get(CATEGORY, VALUE_NAME)

CATEGORY and VALUE_NAME does not defined in config.py. You can add CATEGORY and VALUE as you like. See Official document for more information.

[CATEGORY]
VALUE_NAME = value

Default values defined in ‘nnabla.conf’ placed same directory with config.py is here.

Logger

Wrapper module for logging.

You can use the logger as follows:

from utils.logger import logger

logger.debug('Log message(DEBUG)')
logger.info('Log message(INFO)')
logger.warn('Log message(WARNING)')
logger.error('Log message(ERROR)')
logger.critical('Log message(CRITICAL)')

With the default settings, it should yield the following output:

$ python scripts/logger_test.py
[nnabla][ERROR]: logger_test.py : <module> : 5 : Log message(ERROR)
[nnabla][CRITICAL]: logger_test.py : <module> : 6 : Log message(CRITICAL)

If you want to output log to file. You must create nnabla.conf file and put following entry.

See nnabla.config for more information about config file.

[LOG]
log_file_name = /tmp/nbla.log

After this you can get following output.

$ python scripts/logger_test.py
[nnabla][ERROR]: logger_test.py : <module> : 5 : Log message(ERROR)
[nnabla][CRITICAL]: logger_test.py : <module> : 6 : Log message(CRITICAL)
$ cat /tmp/nbla.log
2017-01-19 14:41:35,132 [nnabla][DEBUG]: scripts/logger_test.py : <module> : 3 : Log message(DEBUG)
2017-01-19 14:41:35,132 [nnabla][INFO]: scripts/logger_test.py : <module> : 4 : Log message(INFO)
2017-01-19 14:41:35,132 [nnabla][ERROR]: scripts/logger_test.py : <module> : 5 : Log message(ERROR)
2017-01-19 14:41:35,132 [nnabla][CRITICAL]: scripts/logger_test.py : <module> : 6 : Log message(CRITICAL)

nnabla.logger.logger

alias of logging.

Auto-forward mode

NNabla provides the dynamic computation graph feature, which enables automatic forward propagation during graph construction. This can be enabled using the set_auto_forward() function. Backpropagation shall be manually executed on the dynamically constructed graph.

nnabla.auto_forward(auto=True)

Context for dynamic graph execution mode.

Parameters

auto (bool) – Whether forward computation is executed during a computation graph construction.

Returns: bool

nnabla.set_auto_forward(auto)

Set the default mode for automatic forward propagation.

When it is set to True , forward propagation is invoked immediately when the computation graph is updated.

Parameters

auto (bool) – Whether forward computation is executed when the computation graph is updated.

Returns: bool

nnabla.get_auto_forward()

Get the state of automatic forward execution.

When it is true, forward execution is invoked during a computation graph definition.

Note

This is called by users usually.

Context

class nnabla.Context(backend=None, array_class='', device_id='0')

Context is used to specify the computation engine (cpu, cuda, cudnn etc.) which the function operator modules and optimizer modules shall be ran on. The context can be set for each function, as well as set globally with functions listed in the context-specifier().

Parameters

• backend (list of str) – ‘cpu’, ‘cuda’, ‘cudnn’ etc.

• array_class (str) – str, ‘CpuArray’, ‘CpuCachedArray’, ‘CudaArray’, ‘CudaCachedArray’ etc.

• device_id (str) – str, default ‘0’

Context Specifier API

nnabla.context_scope(ctx)

Context as Python context.

import nnabla as nn
import nnabla.functions as F
x = nn.Variable([2, 3 ,4])
ctx = nnabla_ext.cuda.context('0')
with context_scope(ctx):
    # Inside with scope, the specified context is used.
    with parameter_scope('w1'):
        l1 = F.relu(F.affine(x, 64))
    with parameter_scope('w2'):
        l2 = F.relu(F.affine(x, 64))

nnabla.set_default_context(ctx)

Set the default context.

Note

It cannot be called inside any context_scope.

Parameters

ctx (Context) – A Context.

nnabla.get_current_context()

Get the current context.

It can be set using nnabla.context_scope() or nnabla.set_default_context() .

Returns

a current context.

Return type

Context