tensorforce.tests package¶

Submodules¶

tensorforce.tests.base_agent_test module¶

class tensorforce.tests.base_agent_test.BaseAgentTest¶

Bases: tensorforce.tests.base_test.BaseTest

Base class for tests of fundamental Agent functionality, i.e. various action types and shapes and internal states.

__init__¶: x.init(…) initializes x; see help(type(x)) for signature

agent = None¶

base_test_pass(name, environment, network, **kwargs)¶

Basic test loop, requires an Agent to achieve a certain performance on an environment.

Parameters:	name (str) – The name of the test. environment (Environment) – The Environment object to use for the test. network (LayerBasedNetwork) – The Network to use for the agent’s model. kwargs (any) – Agent arguments.

base_test_run(name, environment, network, **kwargs)¶

Run test, tests whether algorithm can run and update without compilation errors, not whether it passes.

Parameters:	name (str) – The name of the test. environment (Environment) – The Environment object to use for the test. network (LayerBasedNetwork) – The Network to use for the agent’s model. kwargs (any) – Agent arguments.

config = None¶

exclude_bool = False¶

exclude_bounded = False¶

exclude_float = False¶

exclude_int = False¶

exclude_lstm = False¶

exclude_multi = False¶

multi_config = None¶

pass_threshold = 0.8¶

pre_run(agent, environment)¶: Called before Runner.run.

requires_network = True¶

test_bool()¶: Tests the case of one boolean action.

test_bounded_float()¶: Tests the case of one bounded float action, i.e. with min and max value.

test_float()¶: Tests the case of one float action.

test_int()¶: Tests the case of one integer action.

test_lstm()¶: Tests the case of using internal states via an LSTM layer (for one integer action).

test_multi()¶: Tests the case of multiple actions of different type and shape.

tensorforce.tests.base_test module¶

class tensorforce.tests.base_test.BaseTest¶

Bases: object

Base class for tests of Agent functionality.

__init__¶: x.init(…) initializes x; see help(type(x)) for signature

agent = None¶

base_test_pass(name, environment, network, **kwargs)¶

Basic test loop, requires an Agent to achieve a certain performance on an environment.

Parameters:	name (str) – The name of the test. environment (Environment) – The Environment object to use for the test. network (LayerBasedNetwork) – The Network to use for the agent’s model. kwargs (any) – Agent arguments.

base_test_run(name, environment, network, **kwargs)¶

Run test, tests whether algorithm can run and update without compilation errors, not whether it passes.

Parameters:	name (str) – The name of the test. environment (Environment) – The Environment object to use for the test. network (LayerBasedNetwork) – The Network to use for the agent’s model. kwargs (any) – Agent arguments.

pass_threshold = 0.8¶

pre_run(agent, environment)¶: Called before Runner.run.

requires_network = True¶

tensorforce.tests.test_constant_agent module¶

class tensorforce.tests.test_constant_agent.TestConstantAgent(methodName='runTest')¶

Bases: tensorforce.tests.base_agent_test.BaseAgentTest, unittest.case.TestCase

__init__(methodName='runTest')¶: Create an instance of the class that will use the named test method when executed. Raises a ValueError if the instance does not have a method with the specified name.

addCleanup(function, *args, **kwargs)¶

Add a function, with arguments, to be called when the test is completed. Functions added are called on a LIFO basis and are called after tearDown on test failure or success.

Cleanup items are called even if setUp fails (unlike tearDown).

addTypeEqualityFunc(typeobj, function)¶

Add a type specific assertEqual style function to compare a type.

This method is for use by TestCase subclasses that need to register their own type equality functions to provide nicer error messages.

Parameters:	typeobj – The data type to call this function on when both values are of the same type in assertEqual(). function – The callable taking two arguments and an optional msg= argument that raises self.failureException with a useful error message when the two arguments are not equal.

agent¶: alias of ConstantAgent

assertAlmostEqual(first, second, places=None, msg=None, delta=None)¶

Fail if the two objects are unequal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero, or by comparing that the between the two objects is more than the given delta.

Note that decimal places (from zero) are usually not the same as significant digits (measured from the most signficant digit).

If the two objects compare equal then they will automatically compare almost equal.

assertAlmostEquals(first, second, places=None, msg=None, delta=None)¶

Fail if the two objects are unequal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero, or by comparing that the between the two objects is more than the given delta.

Note that decimal places (from zero) are usually not the same as significant digits (measured from the most signficant digit).

If the two objects compare equal then they will automatically compare almost equal.

assertDictContainsSubset(expected, actual, msg=None)¶: Checks whether actual is a superset of expected.

assertDictEqual(d1, d2, msg=None)¶

assertEqual(first, second, msg=None)¶: Fail if the two objects are unequal as determined by the ‘==’ operator.

assertEquals(first, second, msg=None)¶: Fail if the two objects are unequal as determined by the ‘==’ operator.

assertFalse(expr, msg=None)¶: Check that the expression is false.

assertGreater(a, b, msg=None)¶: Just like self.assertTrue(a > b), but with a nicer default message.

assertGreaterEqual(a, b, msg=None)¶: Just like self.assertTrue(a >= b), but with a nicer default message.

assertIn(member, container, msg=None)¶: Just like self.assertTrue(a in b), but with a nicer default message.

assertIs(expr1, expr2, msg=None)¶: Just like self.assertTrue(a is b), but with a nicer default message.

assertIsInstance(obj, cls, msg=None)¶: Same as self.assertTrue(isinstance(obj, cls)), with a nicer default message.

assertIsNone(obj, msg=None)¶: Same as self.assertTrue(obj is None), with a nicer default message.

assertIsNot(expr1, expr2, msg=None)¶: Just like self.assertTrue(a is not b), but with a nicer default message.

assertIsNotNone(obj, msg=None)¶: Included for symmetry with assertIsNone.

assertItemsEqual(expected_seq, actual_seq, msg=None)¶

An unordered sequence specific comparison. It asserts that actual_seq and expected_seq have the same element counts. Equivalent to:

Asserts that each element has the same count in both sequences. .. rubric:: Example

[0, 1, 1] and [1, 0, 1] compare equal.
[0, 0, 1] and [0, 1] compare unequal.

assertLess(a, b, msg=None)¶: Just like self.assertTrue(a < b), but with a nicer default message.

assertLessEqual(a, b, msg=None)¶: Just like self.assertTrue(a <= b), but with a nicer default message.

assertListEqual(list1, list2, msg=None)¶

A list-specific equality assertion.

Parameters:	list1 – The first list to compare. list2 – The second list to compare. msg – Optional message to use on failure instead of a list of differences.

assertMultiLineEqual(first, second, msg=None)¶: Assert that two multi-line strings are equal.

assertNotAlmostEqual(first, second, places=None, msg=None, delta=None)¶

Fail if the two objects are equal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero, or by comparing that the between the two objects is less than the given delta.

Note that decimal places (from zero) are usually not the same as significant digits (measured from the most signficant digit).

Objects that are equal automatically fail.

assertNotAlmostEquals(first, second, places=None, msg=None, delta=None)¶

Fail if the two objects are equal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero, or by comparing that the between the two objects is less than the given delta.

Note that decimal places (from zero) are usually not the same as significant digits (measured from the most signficant digit).

Objects that are equal automatically fail.

assertNotEqual(first, second, msg=None)¶: Fail if the two objects are equal as determined by the ‘!=’ operator.

assertNotEquals(first, second, msg=None)¶: Fail if the two objects are equal as determined by the ‘!=’ operator.

assertNotIn(member, container, msg=None)¶: Just like self.assertTrue(a not in b), but with a nicer default message.

assertNotIsInstance(obj, cls, msg=None)¶: Included for symmetry with assertIsInstance.

assertNotRegexpMatches(text, unexpected_regexp, msg=None)¶: Fail the test if the text matches the regular expression.

assertRaises(excClass, callableObj=None, *args, **kwargs)¶

Fail unless an exception of class excClass is raised by callableObj when invoked with arguments args and keyword arguments kwargs. If a different type of exception is raised, it will not be caught, and the test case will be deemed to have suffered an error, exactly as for an unexpected exception.

If called with callableObj omitted or None, will return a context object used like this:

The context manager keeps a reference to the exception as the ‘exception’ attribute. This allows you to inspect the exception after the assertion:

assertRaisesRegexp(expected_exception, expected_regexp, callable_obj=None, *args, **kwargs)¶

Asserts that the message in a raised exception matches a regexp.

Parameters:	expected_exception – Exception class expected to be raised. expected_regexp – Regexp (re pattern object or string) expected to be found in error message. callable_obj – Function to be called. args – Extra args. kwargs – Extra kwargs.

assertRegexpMatches(text, expected_regexp, msg=None)¶: Fail the test unless the text matches the regular expression.

assertSequenceEqual(seq1, seq2, msg=None, seq_type=None)¶

An equality assertion for ordered sequences (like lists and tuples).

For the purposes of this function, a valid ordered sequence type is one which can be indexed, has a length, and has an equality operator.

Parameters:	seq1 – The first sequence to compare. seq2 – The second sequence to compare. seq_type – The expected datatype of the sequences, or None if no datatype should be enforced. msg – Optional message to use on failure instead of a list of differences.

assertSetEqual(set1, set2, msg=None)¶

A set-specific equality assertion.

Parameters:	set1 – The first set to compare. set2 – The second set to compare. msg – Optional message to use on failure instead of a list of differences.

assertSetEqual uses ducktyping to support different types of sets, and is optimized for sets specifically (parameters must support a difference method).

assertTrue(expr, msg=None)¶: Check that the expression is true.

assertTupleEqual(tuple1, tuple2, msg=None)¶

A tuple-specific equality assertion.

Parameters:	tuple1 – The first tuple to compare. tuple2 – The second tuple to compare. msg – Optional message to use on failure instead of a list of differences.

assert_(expr, msg=None)¶: Check that the expression is true.

base_test_pass(name, environment, network, **kwargs)¶

Basic test loop, requires an Agent to achieve a certain performance on an environment.

Parameters:	name (str) – The name of the test. environment (Environment) – The Environment object to use for the test. network (LayerBasedNetwork) – The Network to use for the agent’s model. kwargs (any) – Agent arguments.

base_test_run(name, environment, network, **kwargs)¶

Run test, tests whether algorithm can run and update without compilation errors, not whether it passes.

Parameters:	name (str) – The name of the test. environment (Environment) – The Environment object to use for the test. network (LayerBasedNetwork) – The Network to use for the agent’s model. kwargs (any) – Agent arguments.

config = {'action_values': {'action': 1.0}}¶

countTestCases()¶

debug()¶: Run the test without collecting errors in a TestResult

defaultTestResult()¶

doCleanups()¶: Execute all cleanup functions. Normally called for you after tearDown.

exclude_bool = True¶

exclude_bounded = False¶

exclude_float = False¶

exclude_int = True¶

exclude_lstm = True¶

exclude_multi = True¶

fail(msg=None)¶: Fail immediately, with the given message.

failIf(*args, **kwargs)¶

failIfAlmostEqual(*args, **kwargs)¶

failIfEqual(*args, **kwargs)¶

failUnless(*args, **kwargs)¶

failUnlessAlmostEqual(*args, **kwargs)¶

failUnlessEqual(*args, **kwargs)¶

failUnlessRaises(*args, **kwargs)¶

failureException¶: alias of AssertionError

id()¶

longMessage = False¶

maxDiff = 640¶

multi_config = None¶

pass_threshold = 0.8¶

pre_run(agent, environment)¶: Called before Runner.run.

requires_network = False¶

run(result=None)¶

setUp()¶: Hook method for setting up the test fixture before exercising it.

setUpClass()¶: Hook method for setting up class fixture before running tests in the class.

shortDescription()¶

Returns a one-line description of the test, or None if no description has been provided.

The default implementation of this method returns the first line of the specified test method’s docstring.

skipTest(reason)¶: Skip this test.

tearDown()¶: Hook method for deconstructing the test fixture after testing it.

tearDownClass()¶: Hook method for deconstructing the class fixture after running all tests in the class.

test_bool()¶: Tests the case of one boolean action.

test_bounded_float()¶: Tests the case of one bounded float action, i.e. with min and max value.

test_float()¶: Tests the case of one float action.

test_int()¶: Tests the case of one integer action.

test_lstm()¶: Tests the case of using internal states via an LSTM layer (for one integer action).

test_multi()¶: Tests the case of multiple actions of different type and shape.

tensorforce.tests.test_ddqn_agent module¶

tensorforce.tests.test_dqfd_agent module¶

class tensorforce.tests.test_dqfd_agent.TestDQFDAgent(methodName='runTest')¶

Bases: tensorforce.tests.base_agent_test.BaseAgentTest, unittest.case.TestCase

__init__(methodName='runTest')¶: Create an instance of the class that will use the named test method when executed. Raises a ValueError if the instance does not have a method with the specified name.

addCleanup(function, *args, **kwargs)¶

Add a function, with arguments, to be called when the test is completed. Functions added are called on a LIFO basis and are called after tearDown on test failure or success.

Cleanup items are called even if setUp fails (unlike tearDown).

addTypeEqualityFunc(typeobj, function)¶

Add a type specific assertEqual style function to compare a type.

This method is for use by TestCase subclasses that need to register their own type equality functions to provide nicer error messages.

Parameters:	typeobj – The data type to call this function on when both values are of the same type in assertEqual(). function – The callable taking two arguments and an optional msg= argument that raises self.failureException with a useful error message when the two arguments are not equal.

agent¶: alias of DQFDAgent