Skip to content

Commit d0dd818

Browse files
committed
more changes to subagent stuff
1 parent 3108682 commit d0dd818

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

ratinabox/contribs/SubAgent.py

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,17 @@ def plot_trajectory(self,
5353

5454
# other kwargs for SubAgent.plot_trajectory()
5555
**kwargs):
56-
"""A bespoke plotting function taking the same arguments as Agent.plot_trajectory() except now it will jointly plot the True SubAgent and LeadAgent trajectories. By default all kwargs refer to how the SubAgent trajectory is plots and LeadaAgent trajectory is plotted in a dimmer colour (although this can be controlled with lead_agent_plot_kwargs).
56+
"""A bespoke plotting function taking the same arguments as Agent.plot_trajectory() except now it will jointly plot the True SubAgent and LeadAgent trajectories. By default all kwargs refer to how the SubAgent trajectory is plots and LeadAgent trajectory is plotted in a dimmer colour and smaller point size (although this can be controlled with lead_agent_plot_kwargs).
57+
58+
Args:
59+
• t_start --> autosave: see Agent.plot_trajectory
60+
specific args for SubAgent classes
61+
• ontop: if True, plot the SubAgent trajectory on top of the LeadAgent trajectory
62+
• plot_error: if True, will plot an arrow showing the error between the SubAgent and LeadAgent at the end of the trajectory
63+
• show_lead_agent: if True, will plot the trajectory of the LeadAgent
64+
• lead_agent_plot_kwargs: kwargs for plotting the LeadAgent trajectory e.g. it's color, alpha, point size etc. (any kwarg you would pass to Agent.plot_trajectory() can be passed here)
65+
• kwargs: any other kwargs you would pass to Agent.plot_trajectory() can be passed here
5766
58-
• ontop (bool, default False): determines whether the SubAgent trajectory get plotted ontop of or below the LeadAgent trajectory.
59-
• show_lead_agent (bool, default True): determines whether the LeadAgent trajectory is plotted at all.
6067
"""
6168
fig, ax = super().plot_trajectory(
6269
t_start=t_start,

0 commit comments

Comments
 (0)