refactor: name -> benchmark_name (#48)

Author: lwalew

src/mlipaudit/io.py

@@ -34,22 +34,22 @@
 
 
 def write_benchmark_result_to_disk(
-    name: str,
+    benchmark_name: str,
     result: BenchmarkResult,
     output_dir: str | os.PathLike,
 ) -> None:
     """Writes a benchmark result to disk.
 
     Args:
-        name: The benchmark name.
+        benchmark_name: The benchmark name.
         result: The benchmark result.
         output_dir: Directory to which to write the result.
     """
     _output_dir = Path(output_dir)
     _output_dir.mkdir(exist_ok=True, parents=True)
-    (_output_dir / name).mkdir(exist_ok=True)
+    (_output_dir / benchmark_name).mkdir(exist_ok=True)
 
-    with (_output_dir / name / RESULT_FILENAME).open("w") as json_file:
+    with (_output_dir / benchmark_name / RESULT_FILENAME).open("w") as json_file:
         json_as_str = json.loads(result.model_dump_json())  # type: ignore
         json.dump(json_as_str, json_file, indent=2)
 
@@ -192,20 +192,20 @@ def load_scores_from_disk(
 
 
 def write_model_output_to_disk(
-    name: str, model_output: ModelOutput, output_dir: str | os.PathLike
+    benchmark_name: str, model_output: ModelOutput, output_dir: str | os.PathLike
 ) -> None:
     """Writes a model output to disk.
 
     Each model output is written to disk as a zip archive.
 
     Args:
-        name: The benchmark name.
+        benchmark_name: The benchmark name.
         model_output: The model output to save.
         output_dir: Directory to which to write the model output.
     """
     _output_dir = Path(output_dir)
     _output_dir.mkdir(exist_ok=True, parents=True)
-    (_output_dir / name).mkdir(exist_ok=True)
+    (_output_dir / benchmark_name).mkdir(exist_ok=True)
 
     data, arrays = dataclass_to_dict_with_arrays(model_output)
 
@@ -218,7 +218,9 @@ def write_model_output_to_disk(
 
         np.savez(arrays_path, **arrays)
 
-        with ZipFile(_output_dir / name / MODEL_OUTPUT_ZIP_FILENAME, "w") as zip_object:
+        with ZipFile(
+            _output_dir / benchmark_name / MODEL_OUTPUT_ZIP_FILENAME, "w"
+        ) as zip_object:
             zip_object.write(json_path, os.path.basename(json_path))
             zip_object.write(arrays_path, os.path.basename(arrays_path))
 

tests/test_io.py

@@ -38,15 +38,15 @@ def test_benchmark_results_io_works(
 ):
     """Tests whether results can be saved and loaded again to and from disk."""
     model_1_path = Path(tmpdir) / "model_1"
-    for name, result in dummy_benchmark_results_model_1.items():
-        write_benchmark_result_to_disk(name, result, model_1_path)
+    for benchmark_name, result in dummy_benchmark_results_model_1.items():
+        write_benchmark_result_to_disk(benchmark_name, result, model_1_path)
 
     assert set(os.listdir(model_1_path)) == {"benchmark_1", "benchmark_2"}
     assert os.listdir(model_1_path / "benchmark_1") == ["result.json"]
 
     model_2_path = Path(tmpdir) / "model_2"
-    for name, result in dummy_benchmark_results_model_2.items():
-        write_benchmark_result_to_disk(name, result, model_2_path)
+    for benchmark_name, result in dummy_benchmark_results_model_2.items():
+        write_benchmark_result_to_disk(benchmark_name, result, model_2_path)
 
     assert set(os.listdir(model_2_path)) == {"benchmark_1", "benchmark_2"}
     assert os.listdir(model_2_path / "benchmark_1") == ["result.json"]
@@ -121,8 +121,8 @@ def test_model_outputs_io_works(
         ),
     }
 
-    for name, model_output in model_outputs.items():
-        write_model_output_to_disk(name, model_output, Path(tmpdir))
+    for benchmark_name, model_output in model_outputs.items():
+        write_model_output_to_disk(benchmark_name, model_output, Path(tmpdir))
 
     assert set(os.listdir(Path(tmpdir))) == {"benchmark_1", "benchmark_2"}