Simplify the import API for SDGym's results explorer (#432)

Author: R-Palazzo

pyproject.toml

@@ -47,10 +47,8 @@ dependencies = [
     "scipy>=1.12.0;python_version>='3.12' and python_version<'3.13'",
     "scipy>=1.14.1;python_version>='3.13'",
     'tabulate>=0.8.3,<0.9',
-    "torch>=1.13.0;python_version<'3.11'",
-    "torch>=2.0.0;python_version>='3.11' and python_version<'3.12'",
-    "torch>=2.2.0;python_version>='3.12' and python_version<'3.13'",
-    "torch>=2.6.0;python_version>='3.13'",
+    "torch>=2.2.0;python_version>='3.8' and python_version<'3.9'",
+    "torch>=2.6.0;python_version>='3.9'",
     'tqdm>=4.66.3',
     'XlsxWriter>=1.2.8',
     'rdt>=1.17.0',

sdgym/__init__.py

@@ -17,6 +17,7 @@
 from sdgym.cli.summary import make_summary_spreadsheet
 from sdgym.datasets import get_available_datasets, load_dataset
 from sdgym.synthesizers import create_sdv_synthesizer_variant, create_single_table_synthesizer
+from sdgym.result_explorer import ResultsExplorer
 
 # Clear the logging wrongfully configured by tensorflow/absl
 list(map(logging.root.removeHandler, logging.root.handlers))
@@ -30,4 +31,5 @@
     'get_available_datasets',
     'create_sdv_synthesizer_variant',
     'create_single_table_synthesizer',
+    'ResultsExplorer',
 ]

sdgym/progress.py

@@ -56,9 +56,7 @@ def _draw_bar(self, remaining, total, **kwargs):
                 eta = datetime.utcnow() + remaining_time
 
                 elapsed = timedelta(seconds=self.elapsed)
-                msg = (  # noqa: SFS201
-                    '[{0:<{1}}] | {2}/{3} ({4}%) Completed | {5} | {6} | {7}'
-                ).format(
+                msg = ('[{0:<{1}}] | {2}/{3} ({4}%) Completed | {5} | {6} | {7}').format(
                     progress_bar, self.width, done, total, percent, elapsed, remaining_time, eta
                 )
                 self.logger.info(msg)

sdgym/result_explorer/__init__.py

@@ -0,0 +1,5 @@
+"""Benchmark Results Explorer for SDGym."""
+
+from sdgym.result_explorer.result_explorer import ResultsExplorer
+
+__all__ = ['ResultsExplorer']

…sdgym_result_explorer/result_explorer.py sdgym/result_explorer/result_explorer.pysdgym/sdgym_result_explorer/result_explorer.py renamed to sdgym/result_explorer/result_explorer.py sdgym/sdgym_result_explorer/result_explorer.py renamed to sdgym/result_explorer/result_explorer.py

@@ -4,8 +4,8 @@
 
 from sdgym.benchmark import DEFAULT_DATASETS
 from sdgym.datasets import get_dataset_paths, load_dataset
+from sdgym.result_explorer.result_handler import LocalResultsHandler, S3ResultsHandler
 from sdgym.s3 import _get_s3_client, is_s3_path
-from sdgym.sdgym_result_explorer.result_handler import LocalResultsHandler, S3ResultsHandler
 
 
 def _validate_local_path(path):
@@ -14,7 +14,7 @@ def _validate_local_path(path):
         raise ValueError(f"The provided path '{path}' is not a valid local directory.")
 
 
-class SDGymResultsExplorer:
+class ResultsExplorer:
     """Explorer for SDGym benchmark results, supporting both local and S3 storage."""
 
     def __init__(self, path, aws_access_key_id=None, aws_secret_access_key=None):

…/sdgym_result_explorer/result_handler.py sdgym/result_explorer/result_handler.pysdgym/sdgym_result_explorer/result_handler.py renamed to sdgym/result_explorer/result_handler.py sdgym/sdgym_result_explorer/result_handler.py renamed to sdgym/result_explorer/result_handler.py

@@ -14,10 +14,10 @@
 from pydrive2.auth import GoogleAuth
 from pydrive2.drive import GoogleDrive
 
+from sdgym.result_explorer.result_explorer import ResultsExplorer
 from sdgym.result_writer import LocalResultsWriter
 from sdgym.run_benchmark.utils import OUTPUT_DESTINATION_AWS, get_df_to_plot
 from sdgym.s3 import S3_REGION, parse_s3_path
-from sdgym.sdgym_result_explorer.result_explorer import SDGymResultsExplorer
 
 LOGGER = logging.getLogger(__name__)
 SYNTHESIZER_TO_GLOBAL_POSITION = {
@@ -114,7 +114,7 @@ def upload_results(
     """Upload benchmark results to S3, GDrive, and save locally."""
     folder_name = folder_infos['folder_name']
     run_date = folder_infos['date']
-    result_explorer = SDGymResultsExplorer(
+    result_explorer = ResultsExplorer(
         OUTPUT_DESTINATION_AWS,
         aws_access_key_id=aws_access_key_id,
         aws_secret_access_key=aws_secret_access_key,