gr-libs 0.1.6.post1__py3-none-any.whl → 0.1.8__py3-none-any.whl

tutorials/graml_point_maze_tutorial.py

@@ -1,39 +1,59 @@
-
 from stable_baselines3 import SAC, TD3
 from gr_libs.environment.environment import POINT_MAZE, PointMazeProperty
+from gr_libs.environment.utils.utils import domain_to_env_property
 from gr_libs.metrics.metrics import stochastic_amplified_selection
 from gr_libs.ml.neural.deep_rl_learner import DeepRLAgent
 from gr_libs.ml.utils.format import random_subset_with_order
 from gr_libs.recognizer.graml.graml_recognizer import ExpertBasedGraml
 
+
 def run_graml_point_maze_tutorial():
     recognizer = ExpertBasedGraml(
-        domain_name=POINT_MAZE,
-        env_name="PointMaze-FourRoomsEnvDense-11x11"
+        domain_name=POINT_MAZE, env_name="PointMaze-FourRoomsEnvDense-11x11"
     )
 
     recognizer.domain_learning_phase(
-        [(9,1), (9,9), (1,9), (3,3), (3,4), (8,2), (3,7), (2,8)],
-        [(SAC, 200000) for _ in range(8)]
+        [(9, 1), (9, 9), (1, 9), (3, 3), (3, 4), (8, 2), (3, 7), (2, 8)],
+        [(SAC, 200000) for _ in range(8)],
     )
 
     recognizer.goals_adaptation_phase(
-        dynamic_goals = [(4,4), (7,3), (3,7)],
-        dynamic_train_configs=[(SAC, 200000) for _ in range(3)] # for expert sequence generation.
+        dynamic_goals=[(4, 4), (7, 3), (3, 7)],
+        dynamic_train_configs=[
+            (SAC, 200000) for _ in range(3)
+        ],  # for expert sequence generation.
     )
 
+    property_type = domain_to_env_property(POINT_MAZE)
+    env_property = property_type("PointMaze-FourRoomsEnvDense-11x11")
+
     # TD3 is different from recognizer and expert algorithms, which are SAC #
-    actor = DeepRLAgent(domain_name="point_maze", problem_name="PointMaze-FourRoomsEnvDense-11x11-Goal-4x4", algorithm=TD3, num_timesteps=200000)
+    actor = DeepRLAgent(
+        domain_name="point_maze",
+        problem_name="PointMaze-FourRoomsEnvDense-11x11-Goal-4x4",
+        env_prop=env_property,
+        algorithm=TD3,
+        num_timesteps=200000,
+    )
     actor.learn()
     # sample is generated stochastically to simulate suboptimal behavior, noise is added to the actions values #
     full_sequence = actor.generate_observation(
         action_selection_method=stochastic_amplified_selection,
-        random_optimalism=True, # the noise that's added to the actions
+        random_optimalism=True,  # the noise that's added to the actions
+    )
+
+    partial_sequence = random_subset_with_order(
+        full_sequence, (int)(0.5 * len(full_sequence))
+    )
+    closest_goal = recognizer.inference_phase(
+        partial_sequence,
+        PointMazeProperty("PointMaze-FourRoomsEnvDense-11x11-Goal-4x4").str_to_goal(),
+        0.5,
+    )
+    print(
+        f"closest_goal returned by GRAML: {closest_goal}\nactual goal actor aimed towards: (4, 4)"
     )
 
-    partial_sequence = random_subset_with_order(full_sequence, (int)(0.5 * len(full_sequence)))
-    closest_goal = recognizer.inference_phase(partial_sequence, PointMazeProperty("PointMaze-FourRoomsEnvDense-11x11-Goal-4x4").str_to_goal(), 0.5)
-    print(f"closest_goal returned by GRAML: {closest_goal}\nactual goal actor aimed towards: (4, 4)")
 
 if __name__ == "__main__":
-    run_graml_point_maze_tutorial()
+    run_graml_point_maze_tutorial()

tutorials/graql_minigrid_tutorial.py

@@ -1,34 +1,50 @@
-from gr_libs.environment.environment import QLEARNING
+from gr_libs.environment.environment import MINIGRID, QLEARNING
+from gr_libs.environment.utils.utils import domain_to_env_property
 from gr_libs.metrics.metrics import stochastic_amplified_selection
 from gr_libs.ml.tabular.tabular_q_learner import TabularQLearner
 from gr_libs.ml.utils.format import random_subset_with_order
 from gr_libs import Graql
 
+
 def run_graql_minigrid_tutorial():
-    recognizer = Graql(
-        domain_name="minigrid",
-        env_name="MiniGrid-SimpleCrossingS13N4"
-    )
+    recognizer = Graql(domain_name="minigrid", env_name="MiniGrid-SimpleCrossingS13N4")
 
-    #Graql doesn't have a domain learning phase, so we skip it
+    # Graql doesn't have a domain learning phase, so we skip it
 
     recognizer.goals_adaptation_phase(
-        dynamic_goals = [(11,1), (11,11), (1,11)],
-        dynamic_train_configs=[(QLEARNING, 100000) for _ in range(3)] # for expert sequence generation.
+        dynamic_goals=[(11, 1), (11, 11), (1, 11)],
+        dynamic_train_configs=[
+            (QLEARNING, 100000) for _ in range(3)
+        ],  # for expert sequence generation.
     )
+
+    property_type = domain_to_env_property(MINIGRID)
+    env_property = property_type("MiniGrid-SimpleCrossingS13N4")
+
     # TD3 is different from recognizer and expert algorithms, which are SAC #
-    actor = TabularQLearner(domain_name="minigrid", problem_name="MiniGrid-SimpleCrossingS13N4-DynamicGoal-11x1-v0", algorithm=QLEARNING, num_timesteps=100000)
+    actor = TabularQLearner(
+        domain_name="minigrid",
+        problem_name="MiniGrid-SimpleCrossingS13N4-DynamicGoal-11x1-v0",
+        env_prop=env_property,
+        algorithm=QLEARNING,
+        num_timesteps=100000,
+    )
     actor.learn()
     # sample is generated stochastically to simulate suboptimal behavior, noise is added to the actions values #
     full_sequence = actor.generate_observation(
         action_selection_method=stochastic_amplified_selection,
-        random_optimalism=True, # the noise that's added to the actions
+        random_optimalism=True,  # the noise that's added to the actions
+    )
+
+    partial_sequence = random_subset_with_order(
+        full_sequence, (int)(0.5 * len(full_sequence)), is_consecutive=False
+    )
+    closest_goal = recognizer.inference_phase(partial_sequence, (11, 1), 0.5)
+    print(
+        f"closest_goal returned by Graql: {closest_goal}\nactual goal actor aimed towards: (11, 1)"
     )
+    return closest_goal, (11, 1)
 
-    partial_sequence = random_subset_with_order(full_sequence, (int)(0.5 * len(full_sequence)), is_consecutive=False)
-    closest_goal = recognizer.inference_phase(partial_sequence, (11,1), 0.5)
-    print(f"closest_goal returned by Graql: {closest_goal}\nactual goal actor aimed towards: (11, 1)")
-    return closest_goal, (11,1)
 
 if __name__ == "__main__":
-    run_graql_minigrid_tutorial()
+    run_graql_minigrid_tutorial()

CI/README.md

@@ -1,12 +0,0 @@
-## How to build a new docker image including new trained agents:
-1. Install docker
-2. Make sure you have a dataset.zip at your repo root
-3. Make sure you have a classic token in github: https://github.com/settings/tokens . If you don't, create one with package write, read and delete permissions and copy it somewhere safe.
-4. Authenticate to ghcr with docker by running:
-```sh
-echo ghp_REST_OF_TOKEN | docker login ghcr.io -u MatanShamir1 --password-stdin
-```
-3. docker build -t ghcr.io/<your-username>/gr_test_base:latest -f CI/Dockerfile .
-(the -f Dockerfile tells docker which Dockerfile to use and the '.' tells docker what's the build context, or where the dataset.zip should live)
-4. docker push ghcr.io/<your-username>/gr_test_base:latest
-docker push ghcr.io/MatanShamir1/gr_test_base:latest

CI/docker_build_context/Dockerfile

@@ -1,15 +0,0 @@
-FROM python:3.11-slim
-
-# Set workdir
-WORKDIR /app
-
-# Install unzip
-RUN apt-get update && apt-get install -y unzip && rm -rf /var/lib/apt/lists/*
-
-# Copy and unzip the dataset
-COPY dataset.zip .
-RUN unzip dataset.zip && rm dataset.zip
-RUN mv dataset_new dataset
-
-# Just start with bash by default
-CMD [ "bash" ]

gr_libs/recognizer/recognizer_doc.md

@@ -1,61 +0,0 @@
-# Recognizer Module Documentation
-
-This document provides an overview of the recognizer module, including its class hierarchy and instructions for adding a new class of recognizer.
-
-## Class Hierarchy
-
-The recognizer module consists of an abstract base class `Recognizer` and several derived classes, each implementing specific behaviors. The main classes are:
-
-1. **Recognizer (Abstract Base Class)**
-   - `inference_phase()` (abstract method)
-
-2. **LearningRecognizer (Extends Recognizer)**
-   - `domain_learning_phase()`
-
-3. **GaAgentTrainerRecognizer (Extends Recognizer)**
-   - `goals_adaptation_phase()` (abstract method)
-   - `domain_learning_phase()`
-
-4. **GaAdaptingRecognizer (Extends Recognizer)**
-   - `goals_adaptation_phase()` (abstract method)
-
-5. **GRAsRL (Extends Recognizer)**
-   - Implements `goals_adaptation_phase()`
-   - Implements `inference_phase()`
-
-6. **Specific Implementations:**
-   - `Graql (Extends GRAsRL, GaAgentTrainerRecognizer)`
-   - `Draco (Extends GRAsRL, GaAgentTrainerRecognizer)`
-   - `GCDraco (Extends GRAsRL, LearningRecognizer, GaAdaptingRecognizer)`
-   - `Graml (Extends LearningRecognizer)`
-
-## How to Add a New Recognizer Class
-
-To add a new class of recognizer, follow these steps:
-
-1. **Determine the Type of Recognizer:**
-   - Will it require learning? Extend `LearningRecognizer`.
-   - Will it adapt goals dynamically? Extend `GaAdaptingRecognizer`.
-   - Will it train agents for new goals? Extend `GaAgentTrainerRecognizer`.
-   - Will it involve RL-based recognition? Extend `GRAsRL`.
-
-2. **Define the Class:**
-   - Create a new class that extends the appropriate base class(es).
-   - Implement the required abstract methods (`inference_phase()`, `goals_adaptation_phase()`, etc.).
-
-3. **Initialize the Recognizer:**
-   - Ensure proper initialization by calling `super().__init__(*args, **kwargs)`.
-   - Set up any necessary agent storage or evaluation functions.
-
-4. **Implement Core Methods:**
-   - Define how the recognizer processes inference sequences.
-   - Implement learning or goal adaptation logic if applicable.
-
-5. **Register the Recognizer:**
-   - Ensure it integrates properly with the existing system by using the correct `domain_to_env_property()`.
-
-6. **Test the New Recognizer:**
-   - Run experiments to validate its behavior.
-   - Compare results against existing recognizers to ensure correctness.
-
-By following these steps, you can seamlessly integrate a new recognizer into the framework while maintaining compatibility with the existing structure.

gr_libs-0.1.6.post1.dist-info/RECORD

@@ -1,70 +0,0 @@
-CI/README.md,sha256=CbWNAWrXFFwYq3sWAORhoQIE5busoNyYh_rFWVH1enw,800
-CI/docker_build_context/Dockerfile,sha256=Rk7LYTxOW7VVJcmNa8csZ4BwkunMYIiHX4WVSuMam50,311
-evaluation/analyze_results_cross_alg_cross_domain.py,sha256=s_DDh4rNfRnvQ0PDa2d5411jYOa7CaI1YeB8Dpup7QU,9803
-evaluation/create_minigrid_map_image.py,sha256=jaSW3n3tY222iFUeAMqedBP9cvD88GCzPrQ6_XHv5oQ,1242
-evaluation/file_system.py,sha256=SSYnj8QGFkq-8V_0s7x2MWbD88aFaoFY4Ogc_Pt8m6U,1601
-evaluation/generate_experiments_results.py,sha256=oMFt2-TX7g3O6aBflFtQ5q0PT6sngEb8104kpPVMi0s,4051
-evaluation/generate_experiments_results_new_ver1.py,sha256=P9gz3xa0DoRRMQ16GQL3_wVSDYUfh8oZ3BCIUjphKaM,8909
-evaluation/generate_experiments_results_new_ver2.py,sha256=jeKj_wgdM50o2vi8WZI-s3GbsQdsjultHX-8H4Xvus4,12276
-evaluation/generate_task_specific_statistics_plots.py,sha256=rBsqaMe2irP_Cfo-icwIg4_dsleFjEH6eiQCcUBj6WU,15286
-evaluation/get_plans_images.py,sha256=BT-bGWuOPUAYpZVDwk7YMRBLdgKaDbNOBjMrtcl1Vjk,2346
-evaluation/increasing_and_decreasing_.py,sha256=fu1hkEjhOQC3jEsjiS7emW_UPRpVFCaae0d0E2MGZqI,2991
-gr_libs/__init__.py,sha256=-uKsQiHIL7yojbDwlTR-I8sj1WX9XT52PoFbPjtUTKo,145
-gr_libs/_version.py,sha256=C8Me-BH17Mqlv65Ba3Tqc5gFEzabp8fxxyIA9C_XdDQ,517
-gr_libs/environment/__init__.py,sha256=HFVGBcufWf8-ahCo6h_s2pFEyvDy59cFg8z908RgdYo,1038
-gr_libs/environment/environment.py,sha256=d6ZbiAQ4H1aLrUFI8sm0BN9DVW3JtzpkodSi_70Z_PY,6780
-gr_libs/environment/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-gr_libs/environment/utils/utils.py,sha256=4yM3s30KjyuEmWR8UuICE5rR03zsLi3tzqNDvBkdPcU,537
-gr_libs/metrics/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-gr_libs/metrics/metrics.py,sha256=4bnvs5suv-QrK9i1NuOzkE_E8uIzS1nlEazNDRXvZGs,8700
-gr_libs/ml/__init__.py,sha256=jrjxYqvSRgWwFWw7XQP9DzOwvmprMZ2umwT7t-DYtDU,233
-gr_libs/ml/agent.py,sha256=DSnK8nRx9SS76fAOZZEEvA68_meLjzm9lfQpMUXmGQU,1957
-gr_libs/ml/consts.py,sha256=mrbZk8n6QoGzLGaKmaxq4QlAsBbk4fhkCgXLuO9jXKw,365
-gr_libs/ml/base/__init__.py,sha256=MfIYhl_UqH8H7YoTCih8wBFA_gpTOUFq8Ph0_Nq0XQk,68
-gr_libs/ml/base/rl_agent.py,sha256=u9rnb-ma9iDM5b_BlwjcTJGSFezIGrxXINw6b-Dbl8s,1598
-gr_libs/ml/neural/__init__.py,sha256=g-0D5oFX8W52To4OR8vO8kDoBLSxAupVqwcQw8XjT5E,180
-gr_libs/ml/neural/deep_rl_learner.py,sha256=b41_b4GVlYqxhjrr1_YMcGdU9iwcMXsf3zH8D2kEucs,20659
-gr_libs/ml/neural/utils/__init__.py,sha256=bJgPfRnmfDQxdnb0OyRGwzgebEc1PnlO7-GpqszPBcc,106
-gr_libs/ml/neural/utils/dictlist.py,sha256=WpHfdWpVZ_T3PcSnOQUC--ro_tsS0dvam2WG3LcsHDw,1039
-gr_libs/ml/neural/utils/penv.py,sha256=R1uW8sePQqvTlJjpAuMx16eDU6TuGAjQF3hTR1QasMo,1862
-gr_libs/ml/planner/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-gr_libs/ml/planner/mcts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-gr_libs/ml/planner/mcts/mcts_model.py,sha256=N4B2SRWAySW7sJ1JIIkKHbzpxMYo2GcuaSB-eauJmBg,21068
-gr_libs/ml/planner/mcts/utils/__init__.py,sha256=8OE_XolCHiWIZZwS23lqLaLd72tsHwO8cQRRToTC0Lk,45
-gr_libs/ml/planner/mcts/utils/node.py,sha256=WXXaEjfU857yIBF8gKVjr0ZGmU2Du9s1d-dBcA4QS10,1220
-gr_libs/ml/planner/mcts/utils/tree.py,sha256=mLtLtPoqoU0eauNEExY94px5mdbmH-HCsYAYQDZqioI,3382
-gr_libs/ml/sequential/__init__.py,sha256=rusN4ahTvAeAq1Saz6qS_9HEU7WuXDJu2zwhc9WUEYQ,61
-gr_libs/ml/sequential/lstm_model.py,sha256=Vzm-C1URR84PGNEecj69GUtn3ZmOVyh1BAY6CUnfL1Q,8978
-gr_libs/ml/tabular/__init__.py,sha256=jAfjfTFZLLlVm1KUiJdxdnaNGFp1J2KBU89q_vvradM,177
-gr_libs/ml/tabular/state.py,sha256=8xroKF3y3nRX0LK1QX5fRT2PS2WmvcDPp0UvPFdSx2A,733
-gr_libs/ml/tabular/tabular_q_learner.py,sha256=q6Dz4RTX0GjBumUiS2mUFKvEiKUBecj0q1RpWvPvmmE,18972
-gr_libs/ml/tabular/tabular_rl_agent.py,sha256=7w8PYbKi8QgxHJyECWU_rURtT89spg0tHIMI1cDwYc8,3764
-gr_libs/ml/utils/__init__.py,sha256=qH3pcnem5Z6rkQ4RTZi47AXJRe1RkFEST_-DrBmfWcM,258
-gr_libs/ml/utils/env.py,sha256=AWVN0OXYmFU-J3FUiwvEAIY93Suf1oL6VNcxtyWJraM,171
-gr_libs/ml/utils/format.py,sha256=nu7RzVwn_raG_fqqmnqlJgUjtA0yzKztkB3a5QZnRYo,3071
-gr_libs/ml/utils/math.py,sha256=n62zssVOLHnUb4dPofAoFhoLOKl5n_xBzaKQOUQBoNc,440
-gr_libs/ml/utils/other.py,sha256=HKUfeLBbd4DgJxSTs3ya9KQ85Acx4TjycRrtGD9WQ3s,505
-gr_libs/ml/utils/storage.py,sha256=oCdvL_ypCglnSJsyyXzNyV_UJASTfioa3yJhFlFso64,4277
-gr_libs/problems/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-gr_libs/problems/consts.py,sha256=ON7yfKTAKETg7i3okDYuOzEU7KWvynyubl0m7TlU6Hs,38808
-gr_libs/recognizer/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-gr_libs/recognizer/recognizer.py,sha256=ZrApJVdBQxKRYhhDiWLCNGmlxgi674nwgb30BgVggC8,1705
-gr_libs/recognizer/recognizer_doc.md,sha256=RnTvbZhl2opvU7-QT4pULCV5HCdJTw2dsu8WQOOiR3E,2521
-gr_libs/recognizer/gr_as_rl/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-gr_libs/recognizer/gr_as_rl/gr_as_rl_recognizer.py,sha256=84GdfohC2dZoNH_QEo7GpSt8nZWdfqSRKCTY99X_iME,5215
-gr_libs/recognizer/graml/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-gr_libs/recognizer/graml/gr_dataset.py,sha256=lG6m3ulxFELpH1oURnlcmNDWOrxyuzvlAR28ZTqB7L8,7224
-gr_libs/recognizer/graml/graml_recognizer.py,sha256=SGs7rtkA73lbCv9HISa6dfjVUJUhlH54QriVsoGVRss,15672
-gr_libs/recognizer/utils/__init__.py,sha256=ewSroxL7aATvvm-Xzc1_-61mP2LU2U28YaOEqvVVDB0,41
-gr_libs/recognizer/utils/format.py,sha256=e0AnqtPeYoJsV9Z7cEBpgbzTM0hLNxFIjn07fQ3YbQw,492
-tests/test_graml.py,sha256=ZJB2jqtf4Q2-KZredkJq90teqmHBIvigCAQpvR5G110,559
-tests/test_graql.py,sha256=-onMi13e2wStOmB5bYv2f3Ita3QFFiw416XMBkby0OI,141
-tutorials/graml_minigrid_tutorial.py,sha256=ONvxFi79R7d8dcd6gy083Z_yy9A2flhGTDIDRxurdx8,1782
-tutorials/graml_panda_tutorial.py,sha256=wtv_lsw0vsU7j45GKeWecTfE7jzfh4iVGEVnQyaWthM,2063
-tutorials/graml_parking_tutorial.py,sha256=46-sfxmYA9jLRSpqIF9z69MLSfOSTJarfjlQ_Igq294,1769
-tutorials/graml_point_maze_tutorial.py,sha256=mYq3IxYbf9jidq-4VdT3MdStV80Q5lytFv6Xzzn22Ys,1835
-tutorials/graql_minigrid_tutorial.py,sha256=Jb0TCUhiZQkFeafJWUTPnCISd4FKfPrqP-xfHiqCGKE,1635
-gr_libs-0.1.6.post1.dist-info/METADATA,sha256=UPwlwVlbGTpTsUhYwWH5hYr-hSBpcWjrFIA7sWg0Kj4,9620
-gr_libs-0.1.6.post1.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-gr_libs-0.1.6.post1.dist-info/top_level.txt,sha256=rL-bbK-KnLzVbLIUCdN1riH58lup3jG0NJ3LTt_qSwo,38
-gr_libs-0.1.6.post1.dist-info/RECORD,,