gym-examples 3.0.3__py3-none-any.whl → 3.0.5__py3-none-any.whl

gym_examples/__init__.py

@@ -3,7 +3,7 @@ from gym.envs.registration import register
 register(
      id="WSNRouting-v0",
      entry_point="gym_examples.envs:WSNRoutingEnv",
-     max_episode_steps=1000,
+     max_episode_steps=50,
 )
 
-__version__ = "3.0.3"
+__version__ = "3.0.5"

gym_examples/envs/wsn_env.py

@@ -21,6 +21,7 @@ lower_bound = 0  # lower bound of the sensor positions
 upper_bound = 100  # upper bound of the sensor positions
 base_station_position = np.array([(upper_bound - lower_bound)/2, (upper_bound - lower_bound)/2]) # position of the base station
 initial_number_of_packets = 1  # initial number of packets to transmit
+latency_per_hop = 1  # latency per hop in seconds
 
 
 # Define the final reward function using an attention mechanism
@@ -73,9 +74,19 @@ class WSNRoutingEnv(gym.Env):
         self.remaining_energy = np.ones(self.n_sensors) * initial_energy
         self.number_of_packets = np.ones(self.n_sensors, dtype=int) * initial_number_of_packets # number of packets to transmit
         self.episode_count += 1
+
+        self.packets_delivered = 0
+        self.total_energy_consumed = 0
+        self.steps = 0
+        self.first_node_dead_time = None
+        self.total_latency = 0
+        self.packet_latency = np.zeros(self.n_sensors)  # Latency for each packet
+        self.total_packets_sent_by_sensors = 0
+
         return self._get_obs()
 
     def step(self, actions):
+        self.steps += 1
         rewards = [0] * self.n_sensors
         dones = [False] * self.n_sensors
         for i, action in enumerate(actions):
@@ -100,7 +111,16 @@ class WSNRoutingEnv(gym.Env):
                 transmission_energy = self.transmission_energy(self.number_of_packets[i], self.distance_to_base[i])
                 if self.remaining_energy[i] < transmission_energy:
                     continue  # Skip if the sensor does not have enough energy to transmit data to the base station
+                
                 self.update_sensor_energies(i, transmission_energy)
+
+                # Update the metrics
+                self.total_energy_consumed += transmission_energy
+                self.packets_delivered += self.number_of_packets[i]
+                self.total_packets_sent_by_sensors += self.number_of_packets[i]
+                self.total_latency += self.packet_latency[i] + latency_per_hop
+                self.packet_latency[i] = 0
+
                 rewards[i] = self.compute_individual_rewards(i, action)
                 dones[i] = True       
             else:
@@ -112,8 +132,16 @@ class WSNRoutingEnv(gym.Env):
                 reception_energy = self.reception_energy(self.number_of_packets[i])
                 if self.remaining_energy[i] < transmission_energy or self.remaining_energy[action] < reception_energy:
                     continue
+
                 self.update_sensor_energies(i, transmission_energy)  
                 self.update_sensor_energies(action, reception_energy) 
+
+                # Update the metrics
+                self.total_energy_consumed += transmission_energy + reception_energy
+                self.total_packets_sent_by_sensors += self.number_of_packets[i]
+                self.packet_latency[action] += self.packet_latency[i] + latency_per_hop
+                self.packet_latency[i] = 0
+
                 # Compute individual rewards
                 rewards[i] = self.compute_individual_rewards(i, action)
                 # Update the number of packets
@@ -136,6 +164,9 @@ class WSNRoutingEnv(gym.Env):
 
         self.distance_to_base = np.linalg.norm(self.sensor_positions - base_station_position, axis=1)
 
+        if self.first_node_dead_time is None and np.any(self.remaining_energy <= 0):
+            self.first_node_dead_time = self.steps
+
         return self._get_obs(), rewards, dones, {}
 
     def _get_obs(self):
@@ -294,4 +325,24 @@ class WSNRoutingEnv(gym.Env):
         # Cancel the displacement if the sensor goes out of bounds
         for i in range(self.n_sensors):
             if not(np.all(self.sensor_positions[i] >= lower_bound) and np.all(self.sensor_positions[i] <= upper_bound)):
-                self.sensor_positions[i] -= displacement[i]
+                self.sensor_positions[i] -= displacement[i]
+    
+    def get_metrics(self):
+        # Calculate network throughput
+        network_throughput = self.packets_delivered / self.steps if self.steps > 0 else 0
+        # Calculate energy efficiency
+        energy_efficiency = self.packets_delivered / self.total_energy_consumed if self.total_energy_consumed > 0 else 0
+        # Calculate packet delivery ratio
+        packet_delivery_ratio = self.packets_delivered / self.total_packets_sent_by_sensors if self.total_packets_sent_by_sensors > 0 else 0
+        # Calculate network lifetime
+        network_lifetime = self.first_node_dead_time if self.first_node_dead_time is not None else self.steps
+        # Calculate average latency
+        average_latency = self.total_latency / self.packets_delivered if self.packets_delivered > 0 else 0
+
+        return {
+            "network_throughput": network_throughput,
+            "energy_efficiency": energy_efficiency,
+            "packet_delivery_ratio": packet_delivery_ratio,
+            "network_lifetime": network_lifetime,
+            "average_latency": average_latency
+        }

{gym_examples-3.0.3.dist-info → gym_examples-3.0.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: gym-examples
-Version: 3.0.3
+Version: 3.0.5
 Summary: A custom environment for multi-agent reinforcement learning focused on WSN routing.
 Home-page: https://github.com/gedji/CODES.git
 Author: Georges Djimefo

gym_examples-3.0.5.dist-info/RECORD

@@ -0,0 +1,7 @@
+gym_examples/__init__.py,sha256=zR6j1LhHJ8uXhLKrad_AHpAObvekta5hm-SRnVorJIk,192
+gym_examples/envs/__init__.py,sha256=lgMe4pyOuUTgTBUddM0iwMlETsYTwFShny6ifm8PGM8,53
+gym_examples/envs/wsn_env.py,sha256=fRGbJ1P73yX4HCvY0QHKojTzsMjYhWcLpuWybHW7goc,17561
+gym_examples-3.0.5.dist-info/METADATA,sha256=qiL6ukiPIe0mT1wv1A8_VIOXwMShSMu72K41xG9DwTY,410
+gym_examples-3.0.5.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
+gym_examples-3.0.5.dist-info/top_level.txt,sha256=rJRksoAF32M6lTLBEwYzRdo4PgtejceaNnnZ3HeY_Rk,13
+gym_examples-3.0.5.dist-info/RECORD,,

gym_examples-3.0.3.dist-info/RECORD

@@ -1,7 +0,0 @@
-gym_examples/__init__.py,sha256=AAQWRhqIDpGJJCKsRn18CyWJ3sfJZO6h6Vf1KGqpewQ,194
-gym_examples/envs/__init__.py,sha256=lgMe4pyOuUTgTBUddM0iwMlETsYTwFShny6ifm8PGM8,53
-gym_examples/envs/wsn_env.py,sha256=-PySvM8tO8y9f05zdI3d-vbY-7uFEni50gWvAxQlWoU,15187
-gym_examples-3.0.3.dist-info/METADATA,sha256=QEcB4IX0GIDFiRGfinR-uQgv1vDbqB_z8SGSDDOnkig,410
-gym_examples-3.0.3.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
-gym_examples-3.0.3.dist-info/top_level.txt,sha256=rJRksoAF32M6lTLBEwYzRdo4PgtejceaNnnZ3HeY_Rk,13
-gym_examples-3.0.3.dist-info/RECORD,,