garage.sampler.local_sampler module¶
Sampler that runs workers in the main process.
-
class
LocalSampler(worker_factory, agents, envs)[source]¶ Bases:
garage.sampler.sampler.SamplerSampler that runs workers in the main process.
This is probably the simplest possible sampler. It’s called the “Local” sampler because it runs everything in the same process and thread as where it was called from.
Parameters: - worker_factory (WorkerFactory) – Pickleable factory for creating workers. Should be transmitted to other processes / nodes where work needs to be done, then workers should be constructed there.
- agents (Agent or List[Agent]) – Agent(s) to use to perform rollouts. If a list is passed in, it must have length exactly worker_factory.n_workers, and will be spread across the workers.
- envs (gym.Env or List[gym.Env]) – Environment rollouts are performed in. If a list is passed in, it must have length exactly worker_factory.n_workers, and will be spread across the workers.
-
classmethod
from_worker_factory(worker_factory, agents, envs)[source]¶ Construct this sampler.
Parameters: - worker_factory (WorkerFactory) – Pickleable factory for creating workers. Should be transmitted to other processes / nodes where work needs to be done, then workers should be constructed there.
- agents (Agent or List[Agent]) – Agent(s) to use to perform rollouts. If a list is passed in, it must have length exactly worker_factory.n_workers, and will be spread across the workers.
- envs (gym.Env or List[gym.Env]) – Environment rollouts are performed in. If a list is passed in, it must have length exactly worker_factory.n_workers, and will be spread across the workers.
Returns: An instance of cls.
Return type:
-
obtain_exact_trajectories(n_traj_per_worker, agent_update, env_update=None)[source]¶ Sample an exact number of trajectories per worker.
Parameters: - n_traj_per_worker (int) – Exact number of trajectories to gather for each worker.
- agent_update (object) – Value which will be passed into the agent_update_fn before doing rollouts. If a list is passed in, it must have length exactly factory.n_workers, and will be spread across the workers.
- env_update (object) – Value which will be passed into the env_update_fn before doing rollouts. If a list is passed in, it must have length exactly factory.n_workers, and will be spread across the workers.
Returns: - Batch of gathered trajectories. Always in worker
order. In other words, first all trajectories from worker 0, then all trajectories from worker 1, etc.
Return type:
-
obtain_samples(itr, num_samples, agent_update, env_update=None)[source]¶ Collect at least a given number transitions (timesteps).
Parameters: - itr (int) – The current iteration number. Using this argument is deprecated.
- num_samples (int) – Minimum number of transitions / timesteps to sample.
- agent_update (object) – Value which will be passed into the agent_update_fn before doing rollouts. If a list is passed in, it must have length exactly factory.n_workers, and will be spread across the workers.
- env_update (object) – Value which will be passed into the env_update_fn before doing rollouts. If a list is passed in, it must have length exactly factory.n_workers, and will be spread across the workers.
Returns: The batch of collected trajectories.
Return type: