Updated Environment to implement 1D objects for 1D environments. #98
Conversation
ratinabox/Environment.py
Outdated
| @@ -71,7 +71,7 @@ class Environment: | |||
| "boundary": None, # coordinates [[x0,y0],[x1,y1],...] of the corners of a 2D polygon bounding the Env (if None, Env defaults to rectangular). Corners must be ordered clockwise or anticlockwise, and the polygon must be a 'simple polygon' (no holes, doesn't self-intersect). | |||
| "walls": [], # a list of loose walls within the environment. Each wall in the list can be defined by it's start and end coords [[x0,y0],[x1,y1]]. You can also manually add walls after init using Env.add_wall() (preferred). | |||
| "holes": [], # coordinates [[[x0,y0],[x1,y1],...],...] of corners of any holes inside the Env. These must be entirely inside the environment and not intersect one another. Corners must be ordered clockwise or anticlockwise. holes has 1-dimension more than boundary since there can be multiple holes | |||
| "objects": [], #a list of objects within the environment. Each object is defined by it's position [[x0,y0],[x1,y1],...]. By default all objects are type 0, alternatively you can manually add objects after init using Env.add_object(object, type) (preferred). | |||
| "objects": [], # a list of objects within the environment. Each object is defined by it's position [[x0,y0],[x1,y1],...]. By default all objects are type 0, alternatively you can manually add objects after init using Env.add_object(object, type) (preferred). | |||
There was a problem hiding this comment.
the current [[x0,y0],...] implies 2D, shall we rewrite this
There was a problem hiding this comment.
What do you think of this: Each object is defined by its position [[x0,y0],[x1,y1],...] for 2D environments and [[x0],[x1],...] for 1D environments.
ratinabox/Environment.py
Outdated
| self.Agents: list[Agent] = [] # each new Agent will append itself to this list | ||
| self.agents_dict = ( | ||
| {} | ||
| ) # this is a dictionary which allows you to lookup a agent by name |
There was a problem hiding this comment.
I assume you're using a code formatter. can this go back to being 1 line or is
dict = (
{}
}
better for some reason I'm not aware?
There was a problem hiding this comment.
Oh dear - my autoformatter ran on this file. I didn't mean for it to. I'll update the PR to remove the autoformatting changes.
There was a problem hiding this comment.
to be honest that would be great for now but as I said below...we should probably adopt a common style :)))
| f"You have passed {feature_for_2D_only} into a 1D environment. " | ||
| "This is ignored." | ||
| ) | ||
| setattr(self, feature_for_2D_only, list()) |
There was a problem hiding this comment.
thanks for doing this!
ratinabox/Environment.py
Outdated
| autosave=None, | ||
| plot_objects=True, | ||
| **kwargs, | ||
| ): |
There was a problem hiding this comment.
Sure, happy for plot_objects to be an explicit kwarg but if so don't forget to add it to the doc string!
There was a problem hiding this comment.
nice, thanks for doing this. I left a few specific comments on various lines, reply/solve them and we can merge! Some higher level things:
- We should probably think about committing to a code style. I notice your code profiler has made lots of minor changes which are probably all good but like...we should make this uniform across the code base.
- Check out RatInABox2.0 - Roadmap #84 last two comments. In the long run I'd like to make all environmental features (walls, boundaries, objects, etc.) their own classes which would extract a lot of these complexities out of the
Environmentclass into a distinctEnvironmentFeaturesclasses. I think it would simplify the code a lot and make adding crazy wild things like teleports etc. much more straightforward. Feel free to throw in your two-cents. I'm saying this because in the long run these changes may be redundant but for now good to keep up object support inside the environment class.
|
Thanks for your thorough checks, Tom! I've fixed the PR:
|
|
woohoo! excellent stuff, merged and grateful as always for the excellent work :)) |
Implemented objects for 1D environments (adding them to the environment and including them in the plots).
Added checks for parameters passed during environment initialization that do not apply to 1D environments (holes, walls).