From 1efa0cdbfb0587eb63e243e9a7263db21d2e2d6a Mon Sep 17 00:00:00 2001 From: Anderson Date: Wed, 13 Nov 2024 09:59:03 -0800 Subject: [PATCH] Documentation formatting to numpy style --- src/lasdi/param.py | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/src/lasdi/param.py b/src/lasdi/param.py index 8299f6b..fd0981f 100644 --- a/src/lasdi/param.py +++ b/src/lasdi/param.py @@ -75,7 +75,8 @@ def createInitialTrainSpace(self, param_list): def createInitialTrainSpaceForHull(self, param_list): ''' - Concatenates the provided lists of training points into a 2D array. + Concatenates the provided lists of training points into a 2D array. + param_list: A list of parameter dictionaries Output: mesh_grid @@ -113,7 +114,8 @@ def createTestGridSpace(self, param_list): def createTestGridSpaceForHull(self, param_list): ''' - Builds an initial uniform grid for the testing parameters when the test_space is 'hull'. + Builds an initial uniform grid for the testing parameters when the test_space is 'hull'. + param_list: A list of parameter dictionaries Output: gridSizes, mesh_grids, param_grid @@ -132,9 +134,10 @@ def createTestGridSpaceForHull(self, param_list): def createTestHullSpace(self, param_list): ''' - This function builds an initial uniform grid for the testing parameters, and then - returns any testing points which are within the convex hull of the provided - training parameters. + This function builds an initial uniform grid for the testing parameters, and then + returns any testing points which are within the convex hull of the provided + training parameters. + param_list: A list of parameter dictionaries Output: gridSizes, mesh_grids, test_space