From 232712315c28546642adb463a829068182c09d83 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Annika=20=C3=96sterdiekhoff?=
<annika.oesterdiekhoff@uni-bielefeld.de>
Date: Fri, 19 Jan 2024 21:05:08 +0100
Subject: [PATCH] =?UTF-8?q?Gramamar=20=F0=9F=91=8D=F0=9F=98=83?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
overcooked_simulator/__init__.py | 4 ++--
overcooked_simulator/counters.py | 2 +-
overcooked_simulator/game_items.py | 2 +-
overcooked_simulator/order.py | 4 ++--
4 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/overcooked_simulator/__init__.py b/overcooked_simulator/__init__.py
index 05cb8431..c2e43128 100644
--- a/overcooked_simulator/__init__.py
+++ b/overcooked_simulator/__init__.py
@@ -6,7 +6,7 @@ This is the documentation of the Overcooked Simulator.
The package contains of an environment for cooperation between players/agents.
A PyGameGUI visualizes the game to human or visual agents in 2D.
-A 3D web-enabled version (for example for online studies) can be found in the future [here](https://gitlab.ub.uni-bielefeld.de/scs/cocosy/godot-overcooked-3d-visualization)
+A 3D web-enabled version (for example for online studies, currently under development) can be found [here](https://gitlab.ub.uni-bielefeld.de/scs/cocosy/godot-overcooked-3d-visualization)
# Background / Literature
The overcooked/cooking domain is a well established cooperation domain/task.
@@ -17,7 +17,7 @@ Besides, the general adaptations of the original overcooked game.
# Usage / Examples
-Our overcooked simulator is designed for real time interaction but also with reinforcement learning in mind (gym environment).
+Our overcooked simulator is designed for real time interaction but also with reinforcement learning in mind (gymnasium environment).
It focuses on configurability, extensibility and appealing visualization options.
## Human Player
diff --git a/overcooked_simulator/counters.py b/overcooked_simulator/counters.py
index b20ff3f0..6e844d99 100644
--- a/overcooked_simulator/counters.py
+++ b/overcooked_simulator/counters.py
@@ -225,7 +225,7 @@ class ServingWindow(Counter):
class Dispenser(Counter):
- """The class for all dispenser except plate dispenser. Here ingredients can be graped from the player/agent.
+ """The class for all dispensers except plate dispenser. Here ingredients can be grabbed from the player/agent.
At the moment all ingredients have an unlimited stock.
diff --git a/overcooked_simulator/game_items.py b/overcooked_simulator/game_items.py
index 1699481a..52d196a0 100644
--- a/overcooked_simulator/game_items.py
+++ b/overcooked_simulator/game_items.py
@@ -66,7 +66,7 @@ class ItemInfo:
name: str = dataclasses.field(compare=True)
"""The name of the item, is set automatically by the "group" name of the item."""
seconds: float = dataclasses.field(compare=False, default=0)
- """If a progress is needed this defines how long it takes to complete the process in seconds."""
+ """If progress is needed this argument defines how long it takes to complete the process in seconds."""
needs: list[ItemInfo] = dataclasses.field(compare=False, default_factory=list)
"""The ingredients/items which are needed to create the item/start the progress."""
equipment: ItemInfo | None = dataclasses.field(compare=False, default=None)
diff --git a/overcooked_simulator/order.py b/overcooked_simulator/order.py
index 050ec15d..ab3f1fdc 100644
--- a/overcooked_simulator/order.py
+++ b/overcooked_simulator/order.py
@@ -11,7 +11,7 @@ orders:
...
```
-For the `serving_not_ordered_meals` is a function expected. It received a meal as an argument and should return a
+`serving_not_ordered_meals` expects a function. It received a meal as an argument and should return a
tuple of a bool and the score. If the bool is true, the score will be added to the score. Otherwise, it will not
accept the meal for serving.
@@ -195,7 +195,7 @@ class RandomOrderKwarg:
class RandomOrderGeneration(OrderGeneration):
"""A simple order generation based on random sampling with two options.
- Either sample the delay when a new order should come in after the last order comes in or after a meals was served
+ Either sample the delay when a new order should come in after the last order comes in or after a meal was served
(and an order got removed).
To configure it align your kwargs with the `RandomOrderKwarg` class.
--
GitLab