topologicpy 0.8.46__py3-none-any.whl → 0.8.48__py3-none-any.whl

topologicpy/ANN.py

@@ -425,7 +425,7 @@ class ANN():
         path : str
             The path to the folder containing the necessary CSV and YML files.
         taskType : str , optional
-            The type of evaluation task. This can be 'classification' or 'regression'. The default is 'classification'.
+            The type of evaluation task. This can be 'classification' or 'regression'. Default is 'classification'.
         description : str , optional
             The description of the dataset. In keeping with the scikit BUNCH class, this will be saved in the DESCR parameter.
         
@@ -520,7 +520,7 @@ class ANN():
         y : list
             The list of targets.
         testRatio : float , optional
-            The ratio of the dataset to reserve as unseen data for testing. The default is 0.3
+            The ratio of the dataset to reserve as unseen data for testing. Default is 0.3
         randomState : int , optional
             The randomState parameter is used to ensure reproducibility of the results. When you set the randomState parameter to a specific integer value,
             it controls the shuffling of the data before splitting it into training and testing sets.
@@ -565,16 +565,16 @@ class ANN():
         Parameters
         ----------
         title : str , optional
-            The desired title for the dataset. The default is "Untitled".
+            The desired title for the dataset. Default is "Untitled".
         taskType : str , optional
             The desired task type. This can be either 'classification' or 'regression' (case insensitive).
             Classification is a type of supervised learning where the model is trained to predict categorical labels (classes) from input data.
             Regression is a type of supervised learning where the model is trained to predict continuous numerical values from input data.
         testRatio : float , optional
-            The split ratio between training and testing. The default is 0.3. This means that
+            The split ratio between training and testing. Default is 0.3. This means that
             70% of the data will be used for training/validation and 30% will be reserved for testing as unseen data.
         validationRatio : float , optional
-            The split ratio between training and validation. The default is 0.2. This means that
+            The split ratio between training and validation. Default is 0.2. This means that
             80% of the validation data (left over after reserving test data) will be used for training and 20% will be used for validation.
         hiddenLayers : list , optional
             The number of hidden layers and the number of nodes in each layer.
@@ -582,30 +582,30 @@ class ANN():
             16 nodes in the second, and 4 nodes in the last layer, you specify [8,16,4].
             The default is [12,12,12]
         learningRate : float, optional
-            The desired learning rate. The default is 0.001. See https://en.wikipedia.org/wiki/Learning_rate
+            The desired learning rate. Default is 0.001. See https://en.wikipedia.org/wiki/Learning_rate
         epochs : int , optional
-            The desired number of epochs. The default is 10. See https://en.wikipedia.org/wiki/Neural_network_(machine_learning)
+            The desired number of epochs. Default is 10. See https://en.wikipedia.org/wiki/Neural_network_(machine_learning)
         batchSize : int , optional
             The desired number of samples that will be propagated through the network at one time before the model's internal parameters are updated. Instead of updating the model parameters after every single training sample
             (stochastic gradient descent) or after the entire training dataset (batch gradient descent), mini-batch gradient descent updates the model parameters after
-            a specified number of samples, which is determined by batchSize. The default is 1.
+            a specified number of samples, which is determined by batchSize. Default is 1.
         patience : int , optional
             The desired number of epochs with no improvement in the validation loss after which training will be stopped if early stopping is enabled.
         earlyStopping : bool , optional
-            If set to True, the training will stop if the validation loss does not improve after a certain number of epochs defined by patience. The default is True.
+            If set to True, the training will stop if the validation loss does not improve after a certain number of epochs defined by patience. Default is True.
         randomState : int , optional
             The randomState parameter is used to ensure reproducibility of the results. When you set the randomState parameter to a specific integer value,
             it controls the shuffling of the data before splitting it into training and testing sets.
             This means that every time you run your code with the same randomState value and the same dataset, you will get the same split of the data.
             The default is 42 which is just a randomly picked integer number. Specify None for random sampling.
         crossValidationType : str , optional
-            The desired type of cross-validation. This can be one of 'holdout' or 'k-fold'. The default is 'holdout'
+            The desired type of cross-validation. This can be one of 'holdout' or 'k-fold'. Default is 'holdout'
         kFolds : int , optional
-            The number of splits (folds) to use if K-Fold cross validation is selected. The default is 5.
+            The number of splits (folds) to use if K-Fold cross validation is selected. Default is 5.
         interval : int , optional
-            The desired epoch interval at which to report and save metrics data. This must be less than the total number of epochs. The default is 1.
+            The desired epoch interval at which to report and save metrics data. This must be less than the total number of epochs. Default is 1.
         mantissa : int , optional
-            The desired length of the mantissa. The default is 6.
+            The number of decimal places to round the result to. Default is 6.
         
         Returns
         -------
@@ -931,18 +931,18 @@ class ANN():
         model : ANN Model
             The input model.
         width : int , optional
-            The desired figure width in pixels. The default is 900.
+            The desired figure width in pixels. Default is 900.
         height : int , optional
-            The desired figure height in pixels. The default is 900.
+            The desired figure height in pixels. Default is 900.
         template : str , optional
             The desired Plotly template to use for the scatter plot.
             This can be one of ['ggplot2', 'seaborn', 'simple_white', 'plotly',
             'plotly_white', 'plotly_dark', 'presentation', 'xgridoff',
-            'ygridoff', 'gridon', 'none']. The default is "plotly".
+            'ygridoff', 'gridon', 'none']. Default is "plotly".
         colorScale : str , optional
-            The desired type of plotly color scales to use (e.g. "viridis", "plasma"). The default is "viridis". For a full list of names, see https://plotly.com/python/builtin-colorscales/.
+            The desired type of plotly color scales to use (e.g. "viridis", "plasma"). Default is "viridis". For a full list of names, see https://plotly.com/python/builtin-colorscales/.
         colorSamples : int , optional
-            The number of discrete color samples to use for displaying the data. The default is 10.
+            The number of discrete color samples to use for displaying the data. Default is 10.
        
         Returns
         -------
@@ -1063,7 +1063,7 @@ class ANN():
         path : str
             The file path at which to save the model.
         overwrite : bool, optional
-            If set to True, any existing file will be overwritten. Otherwise, it won't. The default is False.
+            If set to True, any existing file will be overwritten. Otherwise, it won't. Default is False.
 
         Returns
         -------

topologicpy/BVH.py

@@ -75,7 +75,7 @@ class BVH:
         topologies : list
             The list of topologies.
         silent : bool , optional
-            If set to True, error and warning messages are suppressed. The default is False.
+            If set to True, error and warning messages are suppressed. Default is False.
         
         Returns
         -------
@@ -152,7 +152,7 @@ class BVH:
         topologies : list
             The list of topologies.
         silent : bool , optional
-            If set to True, error and warning messages are suppressed. The default is False.
+            If set to True, error and warning messages are suppressed. Default is False.
         
         Returns
         -------
@@ -220,7 +220,7 @@ class BVH:
         topologies : list
             The list of topologies.
         silent : bool , optional
-            If set to True, error and warning messages are suppressed. The default is False.
+            If set to True, error and warning messages are suppressed. Default is False.
         
         Returns
         -------
@@ -261,9 +261,9 @@ class BVH:
         bvh : BVH Tree
             The input BVH Tree.
         tolerance : float , optional
-            The desired tolerance. The default is 0.0001.
+            The desired tolerance. Default is 0.0001.
         silent : bool , optional
-            If set to True, error and warning messages are suppressed. The default is False.
+            If set to True, error and warning messages are suppressed. Default is False.
         
         Returns
         -------

topologicpy/CSG.py

@@ -50,13 +50,13 @@ class CSG():
         topology : topologic_core.Topology
             The input topology..
         matrix : list , optional
-            The desired 4X4 transformation matrix to apply to the result before any further operations. The default is None.
+            The desired 4X4 transformation matrix to apply to the result before any further operations. Default is None.
         mantissa : int , optional
-            The desired length of the mantissa. The default is 6.
+            The number of decimal places to round the result to. Default is 6.
         tolerance : float , optional
-            The desired tolerance. The default is 0.0001.
+            The desired tolerance. Default is 0.0001.
         silent : bool , optional
-            If set to True, error and warning messages are suppressed. The default is False.
+            If set to True, error and warning messages are suppressed. Default is False.
         
         Returns
         -------
@@ -115,13 +115,13 @@ class CSG():
         b : topologic_core.Vertex
             The second input vertex.
         matrix : list , optional
-            The desired 4X4 transformation matrix to apply to the result before any further operations. The default is None.
+            The desired 4X4 transformation matrix to apply to the result before any further operations. Default is None.
         mantissa : int , optional
-            The desired length of the mantissa. The default is 6.
+            The number of decimal places to round the result to. Default is 6.
         tolerance : float , optional
-            The desired tolerance. The default is 0.0001.
+            The desired tolerance. Default is 0.0001.
         silent : bool , optional
-            If set to True, error and warning messages are suppressed. The default is False.
+            If set to True, error and warning messages are suppressed. Default is False.
         
         Returns
         -------
@@ -179,11 +179,11 @@ class CSG():
         vertexB : topologic_core.Vertex
             The second input vertex.
         matrix : list , optional
-            The desired 4X4 transformation matrix to apply to the result before any further operations. The default is None.
+            The desired 4X4 transformation matrix to apply to the result before any further operations. Default is None.
         tolerance : float , optional
-            The desired tolerance. The default is 0.0001.
+            The desired tolerance. Default is 0.0001.
         silent : bool , optional
-            If set to True, error and warning messages are suppressed. The default is False.
+            If set to True, error and warning messages are suppressed. Default is False.
         
         Returns
         -------
@@ -248,7 +248,7 @@ class CSG():
         graph : topologic_core.Graph
             The input graph.
         silent : bool , optional
-            If set to True, error and warning messages are suppressed. The default is False.
+            If set to True, error and warning messages are suppressed. Default is False.
         
         Returns
         -------
@@ -350,15 +350,15 @@ class CSG():
         graph : topologic_core.Graph
             The input graph.
         xOffset : float , optional
-            An additional x offset. The default is 0.
+            An additional x offset. Default is 0.
         yOffset : float , optional
-            An additional y offset. The default is 0.
+            An additional y offset. Default is 0.
         zOffset : float , optional
-            An additional z offset. The default is 0.
+            An additional z offset. Default is 0.
         scale : float , optional
-            A desired scale to resize the placed topologies. The default is 1.
+            A desired scale to resize the placed topologies. Default is 1.
         silent : bool , optional
-            If set to True, error and warning messages are suppressed. The default is False.
+            If set to True, error and warning messages are suppressed. Default is False.
         
         Returns
         -------