This style guide summarizes code conventions used in ProbNum. This is intended as a reference for developers.
With respect to code style, the Google Python Style Guide should be applied with some notable additions and exceptions (i.e. docstrings, …). We summarize and expand on this style guide below.
Use absolute imports over relative imports.
import xfor importing packages and modules.
from x import ywhere
xis the package prefix and
yis the module name with no prefix.
from x import y as zif two modules named
yare to be imported or if
yis an inconveniently long name.
import y as zonly when
zis a standard abbreviation (e.g.
__all__ = [...] in
__init__.py files to fix the order in which the methods are visible in the documentation.
This also avoids importing unnecessary functions via import statements
from ... import *.
Many classes and functions are “pulled up” to a higher-level namespace via
files. Import from there wherever there is no chance for
confusion and/or circular imports. This makes imports more readable. When changing the namespace of classes make sure to
to correct module paths in the documentation by adding
SuperClass.__module__ = "probnum.module" to the corresponding
If imports are shortened, the following conventions should be used. Full import paths are always acceptable.
import probnum as pn
from probnum import randvars, linalg, diffeq, statespace
An exception from these rules are type-related modules, which include
Types are always imported directly.
from typing import Optional, Callable
from probnum.typing import FloatArgType
Please do not abbreviate import paths unnecessarily. We do not use the following imports:
import probnum.random_variables as pnrvor
import probnum.filtsmooth as pnfs(correct would be
from probnum import randvars, filtsmooth)
from probnum import random_variables as rvsor
import probnum.random_variables as rvs(the
randvarsname is sufficiently short and does not need to be abbreviated)
While all of these rules obey the Google Python Style Guide,
we use one import convention that deviates from this guide.
If two objects (functions, classes) share the same namespace
Normal are both imported via
probnum.randvars, but their implementation is in different
and one object needs to be imported into the module of the other object, use relative imports. For instance, in
randvars/_normal.py the import reads
from ._randomvariables import RandomVariable
which helps with making the code in
Normal more compact and readable.
Many types representing numeric values, shapes, dtypes, random states, etc. have different
possible representations. For example a shape could be specified in the following ways:
n, (n,), (n, 1), [n], [n, 1].
For this reason most types should be standardized internally to a core set of types defined
probnum.typing, e.g. for numeric types
np.ndarray. Methods for input
argument standardization can be found in
The package itself is written “ProbNum” except when referred to as a package import, then
probnum should be used.
Classes, Functions, Methods and Variables¶
joined_lowerfor functions, methods, attributes, variables
camelCaseonly to conform to pre-existing conventions, e.g. in
Probabilistic Numerical Methods¶
Function names and signatures of PN methods attempt to replicate
scipy naming conventions.
Methods with “Bayesian” in the name come with the prefix
bayesquad; Bayesian quadrature,
BayesFilter; Bayesian filter,
BayesSmoother; Bayesian smoother.
The way an object is represented in the console or printed is defined by the following functions:
repr(obj)is defined by
obj.__repr__()and should return a developer-friendly representation of
obj. If possible, this should be code that can recreate
str(obj)is defined by
obj.__str__()and should return a user-friendly representation of
obj. If no
.__str__()method is implemented, Python will fall back to the
As an example consider
numpy’s array representation
array([[1, 0], [0, 1]])
versus its output of
[[1 0] [0 1]]
Stick to the first few letters for abbreviations if they are sufficiently descriptive:
arr: array; wherever applicable, specify
Further conventions are
unit2unit: convert between types or units, e.g.
mat2arr: convert matrix to array or
s2ms: convert seconds to milliseconds. Can also be used for simple adapter methods, along the lines of
proj: projection (if required:
diffmatdiffusion-matrix, plus the respective
inv*: for inverse of a matrix; e.g.
optional arguments via
fun(t, x, **kwargs)
msg: message, e.g. for issuing raising and warnings (
rv: random variable; if concatenated with e.g.
init, abbreviate to
initrv(initial random variable)
data: data (don’t abbreviate that one)
functions/methods that do something from time
t1with step size
huse the signature
(start, stop, step, **kwargs)or any corresponding subset of that. This is in line with
np.arangefor instance. Use it like
(start=t0, stop=t1, step=h, **kwargs).
jacob: Jacobian, if necessary use
jacobfun. Hessians are
param(s): parameter(s). If abbreviations are necessary (e.g. in inline-function definition, use
idx2, … or
kdx) and not via
i, j, k. The former is more readable (and follows PEP8); the latter may collide with the built-in imaginary constant
A function maps from its
rangeof a random variable is the
domainof its distribution.
Whenever a time-grid is searched for the nearest neighbour of a location (e.g. used in continuous-time evaluation of a Gauss-Markov posterior), consider using
np.searchsorted(..., side="left")(which is the default configuration). This is how it is done everywhere in
Errors and Warnings¶
Stick to the built-in python exceptions (
If dunder method is not implemented for a type, return
warnings.warn(). See https://docs.python.org/2/library/warnings.html or https://docs.python.org/2/library/exceptions.html#exceptions.Warning.
Recall the difference between
TypeErrorPassing arguments of the wrong type (e.g. passing a list when an int is expected) should result in a TypeError. Example:
float(['5 '])since a list cannot be converted to float.
ValueError: Raised when a built-in operation or function receives an argument that has the right type but an inappropriate value. Example: The
floatfunction can take a string, i.e.
'string'is a non-convertible string.
Modules and Folders¶
low(shortened lower caps) for modules/folders in the namespace, e.g.
lowerfor modules/folders not in the namespace, e.g.
probnum/linalg/linearsolvers. Rule of thumb: the more low-level the module is, the longer (more descriptive) the file name can be, because the chances that access is provided through higher-level namespaces are rather high.
Interfaces to PN methods should be in a separate module, while their implementation (in classes) is in the same folder in other files.
All documentation is written in American English. Every publicly visible class or function must have a docstring. Do not use extensive documentation as a clutch for spaghetti code – divide and conquer instead!