Using methods from RxInfer

In the Julia programming language (in contrast to Python for example) the most common way of loading a module is:

using RxInfer

A nice explanation about how modules/packages work in Julia can be found in the official documentation.

In a nutshell, Julia automatically resolves all name collisions and there is no a lot of benefit of importing specific names, e.g.:

import RxInfer: mean

One of the reasons for that is that Julia uses multiple-dispatch capabilities to merge names automatically and will indicate (with a warning) if something went wrong or names have unresolvable collisions on types. As a small example of this feature consider the following small import example:

import RxInfer: mean as mean_from_rxinfer
import Distributions: mean as mean_from_distributions

mean_from_rxinfer === mean_from_distributions
true

Even though we import mean function from two different packages they actually refer to the same object. Worth noting that this is not always the case - Julia will print a warning in case it finds unresolvable conflicts and usage of such functions will be disallowed unless user import them specifically. Read more about this in the section of the Julia's documentation.

# It is easier to let Julia resolve names automatically
# Julia will not overwrite `mean` that is coming from both packages
using RxInfer, Distributions
mean(Normal(0.0, 1.0)) # `Normal` is an object from `Distributions.jl`
0.0
mean(NormalMeanVariance(0.0, 1.0)) # `NormalMeanVariance` is an object from `RxInfer.jl`
0.0

List of available methods

Below you can find a list of exported methods from RxInfer.jl. All methods (even private) can be always accessed with RxInfer. prefix, e.g RxInfer.mean.

Note

Some exported names are (for legacy reasons) intended for private usage only. As a result some of these methods do not have a proper associated documentation with them. We constantly improve RxInfer.jl library and continue to add better documentation for many exported methods, but a small portion of these methods could be removed from this list in the future.

foreach(println, names(RxInfer))
@autoupdates
@average_energy
@call_marginalrule
@call_rule
@constraints
@logscale
@marginalrule
@meta
@model
@node
@rule
AND
AR
ARMeta
ARsafe
ARunsafe
AbstractActor
AbstractActorFactory
AbstractApproximationMethod
AbstractFormConstraint
AbstractMStorage
AbstractMessage
AbstractMixtureModel
AbstractMvNormal
AbstractOperator
AbstractPipelineStage
AbstractSubject
AbstractSubjectFactory
AbstractSubscribable
AbstractVariable
Actor
ActorProxy
ActorSourceProxy
ActorTrait
Adam
AdditiveCouplingLayer
AddonDebug
AddonLogScale
AddonMemory
Arcsine
ArrayLikeVariate
ArrayObservable
AsapScheduler
AsyncPipelineStage
AsyncScheduler
AutoProposal
AutoVar
Autoregressive
AverageEnergy
BIFM
BIFMHelper
BIFMMeta
BaseActorTrait
BayesBase
BehaviorSubject
BehaviorSubjectFactory
Bernoulli
BernoulliLogit
Beta
BetaBinomial
BetaPrime
BetheFreeEnergy
BetheFreeEnergyCheckInfs
BetheFreeEnergyCheckNaNs
BetheFreeEnergyDefaultChecks
BetheFreeEnergyDefaultMarginalSkipStrategy
Binomial
Biweight
BufferActor
CTMeta
CTransition
CVI
CallableTeardownLogic
Categorical
Cauchy
Chernoff
Chi
Chisq
CholeskyVariate
CircularKeepActor
ClosedProd
CompanionMatrix
CompanionMatrixTransposed
CompiledFlowModel
CompletedObservable
CompletionActor
CompletionActorTrait
CompositeFormConstraint
CompositePipelineStage
ConnectableObservable
ConstVariable
ConstantBaseMeasure
ConstraintsSpecification
Contingency
Continuous
ContinuousDistribution
ContinuousMatrixDistribution
ContinuousMultivariateDistribution
ContinuousMultivariateLogPdf
ContinuousTransition
ContinuousTransitionMeta
ContinuousUnivariateDistribution
ContinuousUnivariateLogPdf
Cosine
CountingReal
CustomProdStrategy
DataVariable
DefaultConstraints
DefaultMeta
DefaultPostprocess
DeltaFn
DeltaFnNode
DeltaMeta
Deterministic
DiagNormal
DiagNormalCanon
DifferentialEntropy
Dirac
Dirichlet
DirichletMultinomial
DiscontinuePipelineStage
Discrete
DiscreteDistribution
DiscreteMatrixDistribution
DiscreteMultivariateDistribution
DiscreteNonParametric
DiscreteUniform
DiscreteUnivariateDistribution
Distribution
Distributions
Domain
DoubleExponential
EdgeworthMean
EdgeworthSum
EdgeworthZ
EmptyPipelineStage
Epanechnikov
Erlang
ErrorActor
ErrorActorTrait
Estimator
Exponential
ExponentialFamily
ExponentialFamilyDistribution
ExponentialFamilyDistributionAttributes
ExtraArgumentInCompleteCall
FDist
FactorBoundFreeEnergy
FactorGraphModel
FactorNodeCreationOptions
FactorNodesCollection
FactorizedJoint
FastCholesky
FaultedObservable
FirstNotFoundException
FisherNoncentralHypergeometric
Flow
FlowMeta
FlowModel
FoldLeftProdStrategy
FoldRightProdStrategy
FormConstraintCheckEach
FormConstraintCheckLast
FormConstraintCheckPickDefault
ForwardDiffGrad
Frechet
FullFactorisation
FullNormal
FullNormalCanon
FunctionActor
FunctionObservable
GCV
GCVMetadata
Gamma
GammaDistributionsFamily
GammaInverse
GammaMixture
GammaMixtureNode
GammaShapeRate
GammaShapeScale
GaussHermiteCubature
GaussLaguerreQuadrature
GaussianDistributionsFamily
GaussianMeanPrecision
GaussianMeanVariance
GaussianMixture
GaussianMixtureNode
GaussianWeighteMeanPrecision
GeneralizedExtremeValue
GeneralizedPareto
GenericProd
Geometric
GraphPPL
Gumbel
HalfNormal
Hypergeometric
IMPLY
ImportanceSamplingApproximation
IncludeAll
InconsistentActorWithSubscribableDataTypesError
InconsistentSourceActorDataTypesError
InconsistentSourceOperatorDataTypesError
InconsistentSubjectDataTypesError
InferableOperator
InferableOperatorTrait
InferenceResult
InputLayer
InvalidActorTrait
InvalidActorTraitUsageError
InvalidMultipleTeardownLogicTraitUsageError
InvalidOperatorTrait
InvalidOperatorTraitUsageError
InvalidSubjectTrait
InvalidSubjectTraitUsageError
InvalidSubscribableTrait
InvalidSubscribableTraitUsageError
InvalidTeardownLogic
InvalidTeardownLogicTraitUsageError
InverseGamma
InverseGaussian
InverseWishart
IsoNormal
IsoNormalCanon
JohnsonSU
JointGaussian
JointNormal
JointOrderStatistics
KSDist
KSOneSided
KeepActor
KeepEach
KeepLast
Kolmogorov
Kumaraswamy
LKJ
LKJCholesky
LabeledObservable
LambdaActor
Laplace
LaplaceApproximation
LastNotFoundException
LazyObservable
LeftProposal
LeftTypedOperator
LeftTypedOperatorTrait
Levy
LimitSubscribersGuard
Lindley
Linearization
LinearizedProductOf
LocationScale
LogNormal
LogUniform
LoggerActor
LoggerPipelineStage
Logistic
LogitNormal
MAX_PREGENERATED_MSTORAGE_SIZE
MILLISECONDS_IN_SECOND
MLEstimator
Marginal
Marginalisation
MatrixBeta
MatrixDirichlet
MatrixDistribution
MatrixFDist
MatrixNormal
MatrixReshaped
MatrixTDist
Matrixvariate
MeanField
MeanParametersSpace
MeanToNatural
Message
MetaSpecification
MissingCreateActorFactoryImplementationError
MissingDataArgumentInNextCall
MissingErrorArgumentInErrorCall
MissingOnCallImplementationError
MissingOnCompleteImplementationError
MissingOnErrorImplementationError
MissingOnNextImplementationError
MissingOnScheduledSubscribeImplementationError
MissingOnSubscribeImplementationError
MissingOnUnsubscribeImplementationError
MissingOperatorRightImplementationError
Mixture
MixtureDistribution
MixtureModel
MixtureNode
MomentMatching
Multinomial
Multivariate
MultivariateDistribution
MultivariateGaussianDistributionsFamily
MultivariateMixture
MultivariateNormal
MultivariateNormalDistributionsFamily
MvGaussianMeanCovariance
MvGaussianMeanPrecision
MvGaussianWeightedMeanPrecision
MvLogNormal
MvLogitNormal
MvNormal
MvNormalCanon
MvNormalKnownCov
MvNormalMeanCovariance
MvNormalMeanPrecision
MvNormalMeanScalePrecision
MvNormalWeightedMeanPrecision
MvNormalWishart
MvTDist
NANOSECONDS_IN_MILLISECOND
NANOSECONDS_IN_SECOND
NOT
NaturalParametersSpace
NaturalToMean
NegativeBinomial
NetworkObservable
NeverObservable
NextActor
NextActorTrait
NonConstantBaseMeasure
NonMatrixDistribution
NoncentralBeta
NoncentralChisq
NoncentralF
NoncentralHypergeometric
NoncentralT
NoopPostprocess
Normal
NormalCanon
NormalDistributionsFamily
NormalGamma
NormalInverseGaussian
NormalMeanPrecision
NormalMeanVariance
NormalMixture
NormalMixtureNode
NormalWeightedMeanPrecision
OR
OperatorTrait
OperatorsComposition
OrderStatistic
OverrideHandler
PGeneralizedGaussian
Pareto
PendingScheduler
PendingSubject
PendingSubjectFactory
PermutationLayer
PermutationMatrix
PlanarFlow
PointMass
Poisson
PoissonBinomial
PostponeScheduler
PreserveTypeLeftProd
PreserveTypeProd
PreserveTypeRightProd
Probit
ProbitMeta
ProdCVI
Product
ProductOf
ProxyObservable
PushEach
PushEachBut
PushNew
PushNewBut
PushStrategy
QQPair
RadialFlow
RandomVariable
RandomVariableCreationOptions
Rayleigh
ReactiveMP
RealInterval
RecentSubject
RecentSubjectFactory
ReplaySubject
ReplaySubjectFactory
Rician
RightProposal
RightTypedOperator
RightTypedOperatorTrait
Rocket
RxInfer
RxInferenceEngine
RxInferenceEvent
SampleList
SampleListMeta
Sampleable
ScheduledSubscribable
ScheduledSubscribableTrait
Semicircle
ServerActor
SimpleSubscribableTrait
SingleObservable
Skellam
SkewNormal
SkewedExponentialPower
SkipClamped
SkipClampedAndInitial
SkipInitial
SoftDot
Soliton
SourceProxy
StandardBasisVector
Stochastic
StorageActor
StudentizedRange
Subject
SubjectFactory
SubjectTrait
Subscribable
SubscribableTrait
SubstituteHandler
SufficientStats
SymTriangularDist
SyncActor
SyncActorTimedOutException
SyncFileObservable
TDist
TapAfterSubscription
TapAfterUnsubscription
TapBeforeSubscription
TapBeforeUnsubscription
Teardown
TeardownLogic
TerminalProdArgument
TimerObservable
Transition
TriangularDist
Triweight
Truncated
TruncatedNormal
TypedOperator
TypedOperatorTrait
UT
Uniform
Uninformative
Univariate
UnivariateDistribution
UnivariateGMM
UnivariateGaussianDistributionsFamily
UnivariateMixture
UnivariateNormalDistributionsFamily
UnpackMarginalPostprocess
Unscented
UnscentedTransform
UnspecifiedConstraints
UnspecifiedDimension
UnspecifiedDomain
UnspecifiedFormConstraint
UnspecifiedMeta
UnsubscribableTeardownLogic
ValidSubjectTrait
ValueSupport
VariableBoundEntropy
VariablesCollection
VariateForm
VariationalMessage
VoidActor
VoidTeardown
VoidTeardownLogic
VonMises
VonMisesFisher
WalleniusNoncentralHypergeometric
Weibull
Wishart
WishartDistributionsFamily
ZeroMeanDiagNormal
ZeroMeanDiagNormalCanon
ZeroMeanFullNormal
ZeroMeanFullNormalCanon
ZeroMeanIsoNormal
ZeroMeanIsoNormalCanon
accumulated
actor_extract_type
actor_proxy!
apply_pipeline_stage
approximation_name
approximation_short_name
as_actor
as_marginal
as_message
as_operator
as_subject
as_subscribable
as_teardown
as_variable
async
basemeasure
buffer
call_operator!
call_operator_composition!
canonform
catch_error
ccdf
cdf
censored
cf
cgf
cholinv
cholinv_logdet
chollogdet
cholsqrt
circularkeep
circvar
clamplog
collectLatest
combineLatest
combineLatestUpdates
compile
complete!
completed
component
components
componentwise_logpdf
componentwise_pdf
compute_logscale
concat
concat_map
concat_map_to
concentration
connect
connectable
constrain_form
constvar
convert_paramfloattype
convolve
cor
count
cov
cquantile
create_actor
create_model
create_subject
datavar
debounce_time
deep_eltype
default_form_check_strategy
default_if_empty
default_prod_constraint
default_prod_rule
defer
degree
delay
diageye
dim
dimension
discontinue
distribution_typewrapper
dof
dot
dtanh
entropy
enumerate
error!
error_if
error_if_empty
error_if_not
estimate
exhaust_map
expected_logdet
factorisation
failprob
fastcholesky
fastcholesky!
faulted
file
filter
filter_type
find
find_index
first
fisherinformation
fit
fit_mle
from
functional_dependencies
functionalform
fuse_supports
generate
getapproximation
getattributes
getbasemeasure
getconditioner
getconst
getconstant
getconstraints
getdata
getfisherinformation
getgradlogpartition
getlayers
getlogpartition
getlogscale
getmapping
getmarginal
getmarginals
getmemory
getmeta
getmodel
getnaturalparameters
getnode_ids
getnodes
getoptions
getprediction
getpredictions
getrandom
getsufficientstatistics
getsupport
getvalues
getvardict
getvariables
ghcubature
gradlogpartition
gradlogpdf
hasconstvar
hasdatavar
hasfinitesupport
hasrandomvar
huge
ignore
infer
inference
insupport
interfaces
interval
invcov
invlogccdf
invlogcdf
invscale
is_clamped
is_initial
is_marginalisation
is_moment_matching
is_point_mass_form_constraint
isbasemeasureconstant
isbounded
isconnected
isdeterministic
isequal_typeof
isleptokurtic
islowerbounded
ismesokurtic
isplatykurtic
isprobvec
isproper
isstochastic
isupperbounded
iterable
keep
kldivergence
kurtosis
labeled
lambda
laplace
last
lazy
limit_subscribers
localmarginalnames
localmarginals
location
location!
logccdf
logcdf
logdetcov
logdiffcdf
logger
loglikelihood
logmvbeta
logpartition
logpdf
logpdf!
logpdf_optimized
logpdf_sampling_optimized
lowercase
make
make_form_constraint
make_node
map
map_to
marginalrule
max
mean
mean_cov
mean_invcov
mean_precision
mean_std
mean_var
meandir
meanform
meanlogx
median
merge_map
merged
metadata
mgf
min
mirrorlog
mode
model_name
modes
moment
multicast
mvtrigamma
name
ncategories
ncomponents
network
never
next!
noop
nr_params
nsamples
ntrials
of
on_call!
on_complete!
on_error!
on_next!
on_subscribe!
on_unsubscribe!
operator_right
override
pairwise
parallel
paramfloattype
params
params!
partype
pdf
pdf!
pdfsquaredL2norm
precision
probs
probval
probvec
prod
prod!
product_distribution
promote_paramfloattype
promote_samplefloattype
promote_sampletype
promote_variate_type
proxy
publish
publish_behavior
publish_recent
publish_replay
qqbuild
quantile
race
rand
rand!
randomvar
rate
reduce
ref_count
release!
rerun
resolve_prod_strategy
rule
rxinference
safe
sample
sample!
samplefloattype
sampler
sampletype
sampling_optimized
scale
scale!
scan
schedule_on
scheduled
score
sdtype
server
set!
setTimeout
setmarginal!
setmarginals!
setmessage!
setmessages!
shape
share
share_recent
share_replay
skewness
skip_complete
skip_error
skip_next
skipindex
softdot
some
source_proxy!
span
sqmahal
sqmahal!
srcubature
start_with
std
stdlogx
storage
subscribable_extract_type
subscribe!
substitute
succprob
sufficientstatistics
suffstats
sum
support
switch_map
switch_map_to
sync
take
take_until
tap
tap_on_complete
tap_on_subscribe
tap_on_unsubscribe
teardown!
throwError
timer
tiny
to_array
truncated
tuple_with_left
tuple_with_right
unsubscribe!
update!
uppercase
vague
value_support
var
variate_form
varlogx
void
voidTeardown
weightedmean
weightedmean_cov
weightedmean_invcov
weightedmean_precision
weightedmean_std
weightedmean_var
weights
with_latest
wsample
wsample!
xtlog
zipped