Simplify ax/analysis/plotly directory structure (#2684)

Summary: Pull Request resolved: #2684 Having separate sub-directories for each analysis makes the directory structure & import paths overly verbose. It also necessitates adding an `__init__.py` file for each sub-directory, which is easy to miss and can lead to `module not found` errors elsewhere (see D61607199). This diff eliminates the separate sub-directory for the parallel coordinates analysis. Reviewed By: mpolson64 Differential Revision: D61611408 fbshipit-source-id: 3e91c860993f887cac994fff59950511e6c221b2
facebook · Aug 21, 2024 · 8801c79 · 8801c79
1 parent 84b307d
commit 8801c79
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 10 deletions.
diff --git a/ax/analysis/plotly/__init__.py b/ax/analysis/plotly/__init__.py
@@ -5,9 +5,7 @@
 
 # pyre-strict
 
-from ax.analysis.plotly.parallel_coordinates.parallel_coordinates import (
- ParallelCoordinatesPlot,
-)
+from ax.analysis.plotly.parallel_coordinates import ParallelCoordinatesPlot
 from ax.analysis.plotly.plotly_analysis import PlotlyAnalysis, PlotlyAnalysisCard
 
 __all__ = ["PlotlyAnalysis", "PlotlyAnalysisCard", "ParallelCoordinatesPlot"]
diff --git a/...allel_coordinates/parallel_coordinates.py → ax/analysis/plotly/parallel_coordinates.py b/...allel_coordinates/parallel_coordinates.py → ax/analysis/plotly/parallel_coordinates.py
diff --git a/...inates/tests/test_parallel_coordinates.py → ...plotly/tests/test_parallel_coordinates.py b/...inates/tests/test_parallel_coordinates.py → ...plotly/tests/test_parallel_coordinates.py
@@ -7,7 +7,7 @@
 
 import pandas as pd
 from ax.analysis.analysis import AnalysisCardLevel
-from ax.analysis.plotly.parallel_coordinates.parallel_coordinates import (
+from ax.analysis.plotly.parallel_coordinates import (
  _get_parameter_dimension,
  _select_metric,
  ParallelCoordinatesPlot,

diff --git a/ax/service/scheduler.py b/ax/service/scheduler.py
@@ -19,9 +19,7 @@
 
 import ax.service.utils.early_stopping as early_stopping_utils
 from ax.analysis.analysis import Analysis, AnalysisCard
-from ax.analysis.plotly.parallel_coordinates.parallel_coordinates import (
- ParallelCoordinatesPlot,
-)
+from ax.analysis.plotly.parallel_coordinates import ParallelCoordinatesPlot
 from ax.core.base_trial import BaseTrial, TrialStatus
 from ax.core.experiment import Experiment
 from ax.core.generation_strategy_interface import GenerationStrategyInterface

diff --git a/ax/service/tests/scheduler_test_utils.py b/ax/service/tests/scheduler_test_utils.py
@@ -17,9 +17,7 @@
 from unittest.mock import call, Mock, patch, PropertyMock
 
 import pandas as pd
-from ax.analysis.plotly.parallel_coordinates.parallel_coordinates import (
- ParallelCoordinatesPlot,
-)
+from ax.analysis.plotly.parallel_coordinates import ParallelCoordinatesPlot
 
 from ax.core.arm import Arm
 from ax.core.base_trial import BaseTrial, TrialStatus

diff --git a/sphinx/source/analysis.rst b/sphinx/source/analysis.rst
@@ -38,3 +38,11 @@ Healthcheck Analysis
  :members:
  :undoc-members:
  :show-inheritance:
+
+Parallel Coordinates Analysis
+~~~~~~~~~~~~~~~
+
+.. automodule:: ax.analysis.plotly.parallel_coordinates
+ :members:
+ :undoc-members:
+ :show-inheritance: