Skip to content

Commit be0e3fd

Browse files
committed
Update some docstrings
Before we had the somewhat confusing ``` import StanfordAA228V: disturbance_distribution ``` suggestion. We simplified that now.
1 parent c0acec7 commit be0e3fd

File tree

2 files changed

+11
-15
lines changed

2 files changed

+11
-15
lines changed

src/distributions.jl

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,7 @@ julia> rand(Ds(SimpleGaussian(), [0], [0])) # we can still sample from this
4646
4747
julia> env = ContinuumWorldSurrogate(model=nothing); # other environments have dynamics noise
4848
49-
julia> seed!(0); rand(Ds(env, zeros(2), 0))
50-
2-element Vector{Float64}:
51-
-0.01886010582159417
52-
-0.086290835122697
49+
julia> rand(Ds(env, zeros(2), 0));
5350
```
5451
5552
More details for each system are provided in the project files themselves.

src/system.jl

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ action noise `xa` is rolled out as follows:
115115
116116
## Examples
117117
```jldoctest rollout
118-
julia> pτ = NominalTrajectoryDistribution(sys, 5) # or another `FuzzingDistribution`
118+
julia> pτ = NominalTrajectoryDistribution(sys, 5); # or another `FuzzingDistribution`
119119
120120
julia> τ1 = rollout(sys, pτ); # this is effectively the same as `rollout(sys)`
121121
@@ -245,22 +245,21 @@ julia> struct MyFuzzingDistribution{S<:System} <: TrajectoryDistribution
245245
param::Float64
246246
end;
247247
248-
julia> # IMPORTANT: we have to explicitly import external functions to ovlerload them
249248
250-
julia> import StanfordAA228V: initial_state_distribution, disturbance_distribution, depth
249+
julia> StanfordAA228V.initial_state_distribution(pτ::MyFuzzingDistribution) =
250+
Ps(pτ.sys.env); # system default
251251
252-
julia> initial_state_distribution(pτ::MyFuzzingDistribution) = Ps(pτ.sys.env); # system default
253-
254-
julia> disturbance_distribution(pτ::MyFuzzingDistribution, t) = DisturbanceDistribution(
252+
julia> StanfordAA228V.disturbance_distribution(pτ::MyFuzzingDistribution, t) =
253+
DisturbanceDistribution(
255254
(o) -> Deterministic(0), # action noise -> always 0
256-
(s, a) -> Ds(pτ.sys.env, s, a), # dynamics noise -> regular system dynamics
255+
(s, a) -> Ds(pτ.sys.env, s, a), # dynamics noise -> regular dynamics
257256
(s) -> MvNormal(
258-
mean(Do(sys.sensor, s)),
259-
pτ.param*cov(Do(sys.sensor, s))
257+
zeros(2),
258+
pτ.param*I(2)
260259
) # observation noise -> nominal with increase covariance
261-
);
260+
);
262261
263-
julia> depth(pτ::MyFuzzingDistribution) = 10;
262+
julia> StanfordAA228V.depth(pτ::MyFuzzingDistribution) = 10;
264263
265264
julia> sys = System(ProportionalController([0, 0]),
266265
InvertedPendulum(),

0 commit comments

Comments
 (0)