EDA Toolkit 0.0.8c
EDA Toolkit 0.0.8c:
Summary of Changes:
1. New Features & Enhancements:
-
plot_3d_pdp
Function:- Added
show_modebar
Parameter: Introduced a new boolean parameter,show_modebar
, to allow users to toggle the visibility of the mode bar in Plotly interactive plots. - Custom Margins and Layout Adjustments:
- Added parameters for
left_margin
,right_margin
, andtop_margin
to provide users with more control over the plot layout in Plotly. - Adjusted default values and added options for better customization of the Plotly color bar (
cbar_x
,cbar_thickness
) and title positioning (title_x
,title_y
).
- Added parameters for
- Plotly Configuration:
- Enhanced the configuration options to allow users to enable or disable zoom functionality (
enable_zoom
) in the interactive Plotly plots. - Updated the code to reflect these new parameters, allowing for greater flexibility in the appearance and interaction with the Plotly plots.
- Enhanced the configuration options to allow users to enable or disable zoom functionality (
- Error Handling:
- Added input validation for
html_file_path
andhtml_file_name
to ensure these are provided when necessary based on the selectedplot_type
.
- Added input validation for
- Added
-
plot_2d_pdp
Function:- Introduced
file_prefix
Parameter:- Added a new
file_prefix
parameter to allow users to specify a prefix for filenames when saving grid plots. This change streamlines the naming process for saved plots and improves file organization.
- Added a new
- Enhanced Plot Type Flexibility:
- The
plot_type
parameter now includes an option to generate both grid and individual plots (both
). This feature allows users to create a combination of both layout styles in one function call. - Updated input validation and logic to handle this new option effectively.
- The
- Added
save_plots
Parameter:- Introduced a new parameter,
save_plots
, to control the saving of plots. Users can specify whether to save all plots, only individual plots, only grid plots, or none.
- Introduced a new parameter,
- Custom Margins and Layout Adjustments:
- Included the
save_plots
parameter in the validation process to ensure paths are provided when needed for saving the plots.
- Included the
- Introduced
2. Documentation Updates:
- Docstrings:
- Updated docstrings for both functions to reflect the new parameters and enhancements, providing clearer and more comprehensive guidance for users.
- Detailed the use of new parameters such as
show_modebar
,file_prefix
,save_plots
, and others, ensuring that the function documentation is up-to-date with the latest changes.
3. Refactoring & Code Cleanup:
- Code Structure:
- Improved the code structure to maintain clarity and readability, particularly around the new functionality.
- Consolidated the layout configuration settings for the Plotly plots into a more flexible and user-friendly format, making it easier for users to customize their plots.
This version enhances the usability of the plot_3d_pdp
and plot_2d_pdp
functions, introduces new features for greater flexibility in plot customization, and ensures that the functions are well-documented and easy to use. The updates are backward-compatible and aim to provide a more seamless user experience in generating and saving both 3D and 2D partial dependence plots.