export GenerateEventLogs for PyPI

.github/workflows/test_gedi.yml

@@ -242,4 +242,28 @@ jobs:
 
     - name: Compare output
       run:
-        diff data/validation/2_ense_rmcv_feat.csv output/test/igedi_table_1/2_ense_rmcv_feat.csv
+        diff data/validation/2_ense_rmcv_feat.csv output/test/igedi_table_1/2_ense_rmcv_feat.csv
+
+  test_pypible_generate_event_logs:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.9
+
+    - name: Install dependencies
+      run: |
+        sudo apt-get install build-essential python3 python3-dev
+
+    - name: Install feeed
+      run: |
+        python -m pip install --upgrade pip
+        pip install .
+
+    - name: Run test
+      run:
+        python -c "from gedi import GenerateEventLogs;default_params = {'generator_params': {'experiment': {'ratio_top_20_variants': 0.2, 'epa_normalized_sequence_entropy_linear_forgetting': 0.4}, 'config_space': {'mode': [5, 20], 'sequence': [0.01, 1], 'choice': [0.01, 1], 'parallel': [0.01, 1], 'loop': [0.01, 1], 'silent': [0.01, 1], 'lt_dependency': [0.01, 1], 'num_traces': [10, 101], 'duplicate': [0], 'or': [0]}, 'n_trials': 50}}; GenerateEventLogs(default_params)"

gedi/__init__.py

@@ -1,3 +1,4 @@
 from .run import gedi
+from .generator import GenerateEventLogs
 
-__all__=['gedi']
+__all__=['gedi', 'GenerateEventLogs']

gedi/generator.py

@@ -135,8 +135,11 @@ def add_extension_before_traces(xes_file):
 
 class GenerateEventLogs():
     # TODO: Clarify nomenclature: experiment, task, objective as in notebook (https://github.com/lmu-dbs/gedi/blob/main/notebooks/grid_objectives.ipynb)
-    def __init__(self, params):
+    def __init__(self, params=None) -> None:
         print("=========================== Generator ==========================")
+        if params is None:
+            default_params = {'generator_params': {'experiment': {'ratio_top_20_variants': 0.2, 'epa_normalized_sequence_entropy_linear_forgetting': 0.4}, 'config_space': {'mode': [5, 20], 'sequence': [0.01, 1], 'choice': [0.01, 1], 'parallel': [0.01, 1], 'loop': [0.01, 1], 'silent': [0.01, 1], 'lt_dependency': [0.01, 1], 'num_traces': [10, 101], 'duplicate': [0], 'or': [0]}, 'n_trials': 50}}
+            raise TypeError(f"Missing 'params'. Please provide a dictionary with generator parameters as so: {default_params}. See https://github.com/lmu-dbs/gedi for more info.")
         print(f"INFO: Running with {params}")
         start = dt.now()
         if params.get(OUTPUT_PATH) is None:
@@ -188,7 +191,7 @@ class GenerateEventLogs():
             write_xes(temp['log'], save_path)
             add_extension_before_traces(save_path)
             print("SUCCESS: Saved generated event log in", save_path)
-        print(f"SUCCESS: Generator took {dt.now()-start} sec. Generated {len(self.log_config)} event logs.")
+        print(f"SUCCESS: Generator took {dt.now()-start} sec. Generated {len(self.log_config)} event log(s).")
         print(f"         Saved generated logs in {self.output_path}")
         print("========================= ~ Generator ==========================")