Skip to content

Commit 941e36e

Browse files
Fix docs toc and bump version (#36)
* Fix table of contents (sidebar) in docs. * Upgrade requirements. * Add comment to update GA analytics ID in RTD settings page. * v0.1.12
1 parent c82bb90 commit 941e36e

File tree

11 files changed

+174
-18
lines changed

11 files changed

+174
-18
lines changed

coax/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
__version__ = '0.1.11'
1+
__version__ = '0.1.12'
22

33

44
# expose specific classes and functions

coax/utils/__init__.py

Lines changed: 56 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,6 @@
55
66
This is a collection of utility (helper) functions used throughout the package.
77
8-
9-
Object Reference
10-
----------------
11-
128
.. autosummary::
139
:nosignatures:
1410
@@ -66,6 +62,62 @@
6662
coax.utils.unvectorize
6763
6864
65+
Object Reference
66+
----------------
67+
68+
.. autoclass:: coax.utils.OrnsteinUhlenbeckNoise
69+
.. autoclass:: coax.utils.StepwiseLinearFunction
70+
.. autoclass:: coax.utils.SegmentTree
71+
.. autoclass:: coax.utils.SumTree
72+
.. autoclass:: coax.utils.MinTree
73+
.. autoclass:: coax.utils.MaxTree
74+
.. autofunction:: coax.utils.argmax
75+
.. autofunction:: coax.utils.argmin
76+
.. autofunction:: coax.utils.batch_to_single
77+
.. autofunction:: coax.utils.check_array
78+
.. autofunction:: coax.utils.check_preprocessors
79+
.. autofunction:: coax.utils.clipped_logit
80+
.. autofunction:: coax.utils.default_preprocessor
81+
.. autofunction:: coax.utils.diff_transform
82+
.. autofunction:: coax.utils.diff_transform_matrix
83+
.. autofunction:: coax.utils.docstring
84+
.. autofunction:: coax.utils.double_relu
85+
.. autofunction:: coax.utils.dump
86+
.. autofunction:: coax.utils.dumps
87+
.. autofunction:: coax.utils.enable_logging
88+
.. autofunction:: coax.utils.generate_gif
89+
.. autofunction:: coax.utils.get_env_attr
90+
.. autofunction:: coax.utils.get_grads_diagnostics
91+
.. autofunction:: coax.utils.get_magnitude_quantiles
92+
.. autofunction:: coax.utils.get_transition_batch
93+
.. autofunction:: coax.utils.has_env_attr
94+
.. autofunction:: coax.utils.idx
95+
.. autofunction:: coax.utils.is_policy
96+
.. autofunction:: coax.utils.is_qfunction
97+
.. autofunction:: coax.utils.is_reward_function
98+
.. autofunction:: coax.utils.is_stochastic
99+
.. autofunction:: coax.utils.is_transition_model
100+
.. autofunction:: coax.utils.is_vfunction
101+
.. autofunction:: coax.utils.isscalar
102+
.. autofunction:: coax.utils.jit
103+
.. autofunction:: coax.utils.load
104+
.. autofunction:: coax.utils.loads
105+
.. autofunction:: coax.utils.make_dmc
106+
.. autofunction:: coax.utils.merge_dicts
107+
.. autofunction:: coax.utils.pretty_print
108+
.. autofunction:: coax.utils.pretty_repr
109+
.. autofunction:: coax.utils.quantiles
110+
.. autofunction:: coax.utils.quantiles_uniform
111+
.. autofunction:: coax.utils.quantile_cos_embedding
112+
.. autofunction:: coax.utils.reload_recursive
113+
.. autofunction:: coax.utils.render_episode
114+
.. autofunction:: coax.utils.safe_sample
115+
.. autofunction:: coax.utils.single_to_batch
116+
.. autofunction:: coax.utils.stack_trees
117+
.. autofunction:: coax.utils.sync_shared_params
118+
.. autofunction:: coax.utils.tree_ravel
119+
.. autofunction:: coax.utils.unvectorize
120+
69121
"""
70122

71123
from ._action_noise import OrnsteinUhlenbeckNoise

doc/_intersphinx/jax.inv

1.43 KB
Binary file not shown.

doc/_intersphinx/jax.txt

Lines changed: 81 additions & 6 deletions
Large diffs are not rendered by default.

doc/_intersphinx/python3.inv

175 Bytes
Binary file not shown.

doc/_intersphinx/python3.txt

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -277,6 +277,7 @@ c:function
277277
PyFloat_Unpack2 c-api/float.html#c.PyFloat_Unpack2
278278
PyFloat_Unpack4 c-api/float.html#c.PyFloat_Unpack4
279279
PyFloat_Unpack8 c-api/float.html#c.PyFloat_Unpack8
280+
PyFrame_Check c-api/frame.html#c.PyFrame_Check
280281
PyFrame_GetBack c-api/frame.html#c.PyFrame_GetBack
281282
PyFrame_GetBuiltins c-api/frame.html#c.PyFrame_GetBuiltins
282283
PyFrame_GetCode c-api/frame.html#c.PyFrame_GetCode
@@ -1510,6 +1511,7 @@ c:functionParam
15101511
PyFloat_Unpack4.p c-api/float.html#c.PyFloat_Unpack4
15111512
PyFloat_Unpack8.le c-api/float.html#c.PyFloat_Unpack8
15121513
PyFloat_Unpack8.p c-api/float.html#c.PyFloat_Unpack8
1514+
PyFrame_Check.obj c-api/frame.html#c.PyFrame_Check
15131515
PyFrame_GetBack.frame c-api/frame.html#c.PyFrame_GetBack
15141516
PyFrame_GetBuiltins.frame c-api/frame.html#c.PyFrame_GetBuiltins
15151517
PyFrame_GetCode.frame c-api/frame.html#c.PyFrame_GetCode
@@ -2850,6 +2852,7 @@ c:member
28502852
PyDateTime_TimeZone_UTC c-api/datetime.html#c.PyDateTime_TimeZone_UTC
28512853
PyDict_Type c-api/dict.html#c.PyDict_Type
28522854
PyFloat_Type c-api/float.html#c.PyFloat_Type
2855+
PyFrame_Type c-api/frame.html#c.PyFrame_Type
28532856
PyFrozenSet_Type c-api/set.html#c.PyFrozenSet_Type
28542857
PyFunction_Type c-api/function.html#c.PyFunction_Type
28552858
PyGen_Type c-api/gen.html#c.PyGen_Type
@@ -3857,6 +3860,7 @@ py:attribute
38573860
sqlite3.Cursor.connection library/sqlite3.html#sqlite3.Cursor.connection
38583861
sqlite3.Cursor.description library/sqlite3.html#sqlite3.Cursor.description
38593862
sqlite3.Cursor.lastrowid library/sqlite3.html#sqlite3.Cursor.lastrowid
3863+
sqlite3.Cursor.row_factory library/sqlite3.html#sqlite3.Cursor.row_factory
38603864
sqlite3.Cursor.rowcount library/sqlite3.html#sqlite3.Cursor.rowcount
38613865
sqlite3.Error.sqlite_errorcode library/sqlite3.html#sqlite3.Error.sqlite_errorcode
38623866
sqlite3.Error.sqlite_errorname library/sqlite3.html#sqlite3.Error.sqlite_errorname
@@ -13347,6 +13351,7 @@ std:label
1334713351
action library/argparse.html#action
1334813352
advanced-debugging Advanced Debugger Support : c-api/init.html#advanced-debugging
1334913353
allocating-objects Allocating Objects on the Heap : c-api/allocation.html#allocating-objects
13354+
allocator-domains c-api/memory.html#id1
1335013355
allos Generic Operating System Services : library/allos.html#allos
1335113356
allow_abbrev library/argparse.html#allow-abbrev
1335213357
and Boolean operations : reference/expressions.html#and
@@ -13363,6 +13368,7 @@ std:label
1336313368
api-reference API Reference : distutils/apiref.html#api-reference
1336413369
api-types Types : c-api/intro.html#api-types
1336513370
apiabiversion API and ABI Versioning : c-api/apiabiversion.html#apiabiversion
13371+
applications Applications : library/struct.html#applications
1336613372
arbitrary-object-messages Using arbitrary objects as messages : howto/logging.html#arbitrary-object-messages
1336713373
archiving Data Compression and Archiving : library/archiving.html#archiving
1336813374
archiving-operations Archiving operations : library/shutil.html#archiving-operations
@@ -13617,6 +13623,7 @@ std:label
1361713623
ctypes-calling-functions Calling functions : library/ctypes.html#ctypes-calling-functions
1361813624
ctypes-calling-functions-continued Calling functions, continued : library/ctypes.html#ctypes-calling-functions-continued
1361913625
ctypes-calling-functions-with-own-custom-data-types Calling functions with your own custom data types: library/ctypes.html#ctypes-calling-functions-with-own-custom-data-types
13626+
ctypes-calling-variadic-functions Calling varadic functions : library/ctypes.html#ctypes-calling-variadic-functions
1362013627
ctypes-ctypes-reference ctypes reference : library/ctypes.html#ctypes-ctypes-reference
1362113628
ctypes-ctypes-tutorial ctypes tutorial : library/ctypes.html#ctypes-ctypes-tutorial
1362213629
ctypes-data-types Data types : library/ctypes.html#ctypes-data-types
@@ -13806,8 +13813,8 @@ std:label
1380613813
entry-points Entry points : library/importlib.metadata.html#entry-points
1380713814
enum-advanced-tutorial Programmatic access to enumeration members and their attributes: howto/enum.html#enum-advanced-tutorial
1380813815
enum-basic-tutorial howto/enum.html#enum-basic-tutorial
13809-
enum-class-differences How are Enums different? : howto/enum.html#enum-class-differences
13810-
enum-cookbook howto/enum.html#enum-cookbook
13816+
enum-class-differences How are Enums and Flags different? : howto/enum.html#enum-class-differences
13817+
enum-cookbook Enum Cookbook : howto/enum.html#enum-cookbook
1381113818
enum-time-period TimePeriod : howto/enum.html#enum-time-period
1381213819
enumtype-examples Subclassing EnumType : howto/enum.html#enumtype-examples
1381313820
epoch library/time.html#epoch
@@ -13973,6 +13980,7 @@ std:label
1397313980
implementing-the-arithmetic-operations Implementing the arithmetic operations : library/numbers.html#implementing-the-arithmetic-operations
1397413981
implicit-joining Implicit line joining : reference/lexical_analysis.html#implicit-joining
1397513982
import The import statement : reference/simple_stmts.html#import
13983+
import-distribution-package-mapping Mapping import to distribution packages : library/importlib.metadata.html#import-distribution-package-mapping
1397613984
import-dunder-main Special considerations for __main__ : reference/import.html#import-dunder-main
1397713985
import-mod-attrs Import-related module attributes : reference/import.html#import-mod-attrs
1397813986
importing Importing Modules : c-api/import.html#importing
@@ -14290,6 +14298,7 @@ std:label
1429014298
otherlicenses Licenses and Acknowledgements for Incorporated Software: license.html#otherlicenses
1429114299
otherobjects Function Objects : c-api/concrete.html#otherobjects
1429214300
ownershiprules Ownership Rules : extending/extending.html#ownershiprules
14301+
package-distributions Mapping import to distribution packages : library/importlib.metadata.html#package-distributions
1429314302
package-index The Python Package Index (PyPI) : distutils/packageindex.html#package-index
1429414303
package-path-rules module.__path__ : reference/import.html#package-path-rules
1429514304
parenthesized Parenthesized forms : reference/expressions.html#parenthesized
@@ -14417,6 +14426,7 @@ std:label
1441714426
raise The raise statement : reference/simple_stmts.html#raise
1441814427
random-examples Examples : library/random.html#random-examples
1441914428
rawconfigparser-objects RawConfigParser Objects : library/configparser.html#rawconfigparser-objects
14429+
re-conditional-expression library/re.html#re-conditional-expression
1442014430
re-examples Regular Expression Examples : library/re.html#re-examples
1442114431
re-objects Regular Expression Objects : library/re.html#re-objects
1442214432
re-syntax Regular Expression Syntax : library/re.html#re-syntax
@@ -14540,6 +14550,7 @@ std:label
1454014550
sqlite3-default-converters Default adapters and converters : library/sqlite3.html#sqlite3-default-converters
1454114551
sqlite3-exceptions Exceptions : library/sqlite3.html#sqlite3-exceptions
1454214552
sqlite3-explanation Explanation : library/sqlite3.html#sqlite3-explanation
14553+
sqlite3-howto-row-factory How to create and use row factories : library/sqlite3.html#sqlite3-howto-row-factory
1454314554
sqlite3-howtos How-to guides : library/sqlite3.html#sqlite3-howtos
1454414555
sqlite3-intro library/sqlite3.html#sqlite3-intro
1454514556
sqlite3-module-constants Module constants : library/sqlite3.html#sqlite3-module-constants
@@ -14580,7 +14591,9 @@ std:label
1458014591
struct-alignment Byte Order, Size, and Alignment : library/struct.html#struct-alignment
1458114592
struct-examples Examples : library/struct.html#struct-examples
1458214593
struct-format-strings Format Strings : library/struct.html#struct-format-strings
14594+
struct-native-formats Native Formats : library/struct.html#struct-native-formats
1458314595
struct-objects Classes : library/struct.html#struct-objects
14596+
struct-standard-formats Standard Formats : library/struct.html#struct-standard-formats
1458414597
sub-interpreter-support Sub-interpreter support : c-api/init.html#sub-interpreter-support
1458514598
sub-slots c-api/typeobj.html#sub-slots
1458614599
subclassing-reprs Subclassing Repr Objects : library/reprlib.html#subclassing-reprs

doc/coax/utils.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
11
.. automodule:: coax.utils
2+
:no-members:
3+
:no-inherited-members:
4+
:no-special-members:

doc/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,7 @@ def get_release():
134134
}
135135

136136
# get google analytics tracking id from: https://analytics.google.com
137+
# update the tracking id here: https://readthedocs.org/dashboard/coax/advanced/
137138
# add GA_TRACKING_ID env var to: https://readthedocs.org/dashboard/coax/environmentvariables/
138139
# format: GA4_TRACKING_ID=G-XXXXXXXXXX (or legacy tracking id: GA_TRACKING_ID=UA-XXXXXXX-1)
139140
if os.environ.get('GA4_TRACKING_ID', '').startswith('G-'):

doc/release_notes.rst

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,21 @@ If you need any of the features from the pre-release version listed under "Upcom
1212
Upcoming
1313
--------
1414

15-
- Fix affine transform for composite distributions.
15+
- ...
16+
17+
18+
v0.1.12
19+
-------
20+
21+
- Add DeepMind Control Suite example (`#29 <https://github.com/coax-dev/coax/pull/29>`_); see :doc:`/examples/dmc/sac`.
1622
- Add :func:`coax.utils.sync_shared_params` utility; example in :doc:`A2C stub </examples/stubs/a2c>`.
17-
- Bug fix: set logging level on ``TrainMonitor.logger`` itself.
23+
- Improved performance for replay buffer (`#25 <https://github.com/coax-dev/coax/pull/25>`_)
24+
- Bug fix: random_seed in _prioritized (`#24 <https://github.com/coax-dev/coax/pull/24>`_)
25+
- Update to new Jax API (`#27 <https://github.com/coax-dev/coax/pull/27>`_)
26+
- Add Update to ``gym==0.26.x`` (`#28 <https://github.com/coax-dev/coax/pull/28>`_).
27+
- Bug fix: set logging level on ``TrainMonitor.logger`` itself (`550a965 <https://github.com/coax-dev/coax/commit/550a965d17002bf552ab2fbea49801c65b322c7b>_`).
28+
- Bug fix: fix affine transform for composite distributions (`48ca9ce <https://github.com/coax-dev/coax/commit/48ca9ced42123e906969076dff88540b98e6d0bb>_`)
29+
- Bug fix: `#33 <https://github.com/coax-dev/coax/issues/33>`_
1830

1931

2032
v0.1.11

doc/versions.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@
109109

110110
function updateCommand() {
111111
var codecellName = 'codecell0';
112-
var jaxlibVersion = '0.3.20'; // this is automatically updated from conf.py
112+
var jaxlibVersion = '0.3.22'; // this is automatically updated from conf.py
113113

114114
// get the selected os version
115115
var osVersion = null;

0 commit comments

Comments
 (0)