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

topologicpy/DGL.py

@@ -1480,7 +1480,7 @@ class DGL:
         predicted : list
             The input list of predicted values.
         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
         -------
@@ -1519,7 +1519,7 @@ class DGL:
         predicted : list
             The input list of predicted values.
         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
         -------
@@ -1576,7 +1576,7 @@ class DGL:
         method : str, optional
             The method of sampling. This can be "undersampling" or "oversampling". It is case insensitive. The defaul is "undersampling".
         key : str , optional
-            The key used for the node attributes. The default is "feat".
+            The key used for the node attributes. Default is "feat".
         
         Returns
         -------
@@ -1622,9 +1622,9 @@ class DGL:
         categories : list
             The list of categories of node features.
         node_attr_key : str , optional
-            The dictionary key of the node features. The default is "feat".
+            The dictionary key of the node features. Default is "feat".
         tolerance : float , optional
-            The desired tolerance. The default is 0.0001.
+            The desired tolerance. Default is 0.0001.
 
         Returns
         -------
@@ -1697,9 +1697,9 @@ class DGL:
         labels : list
             The input list of labels.
         categories : list , optional
-            The list of node categories. If not specified, the categories are computed directly from the labels. The default is None.
+            The list of node categories. If not specified, the categories are computed directly from the labels. 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.
 
         Returns
         -------
@@ -1770,7 +1770,7 @@ class DGL:
         predicted : list
             The input list of predicts labels.
         normalized : bool , optional
-            If set to True, the returned data will be normalized (proportion of 1). Otherwise, actual numbers are returned. The default is False.
+            If set to True, the returned data will be normalized (proportion of 1). Otherwise, actual numbers are returned. Default is False.
 
         Returns
         -------
@@ -1942,7 +1942,7 @@ class DGL:
         Parameters
         ----------
         name : str
-            The name of the sample dataset. This can be "ENZYMES", "DD", "COLLAB", or "MUTAG". It is case insensitive. The default is "ENZYMES".
+            The name of the sample dataset. This can be "ENZYMES", "DD", "COLLAB", or "MUTAG". It is case insensitive. Default is "ENZYMES".
 
         Returns
         -------
@@ -1973,7 +1973,7 @@ class DGL:
         Parameters
         ----------
         name : str
-            The name of the sample dataset to load. This can be "Cora", "Citeseer", or "Pubmed". It is case insensitive. The default is "Cora".
+            The name of the sample dataset to load. This can be "Cora", "Citeseer", or "Pubmed". It is case insensitive. Default is "Cora".
 
         Raises
         ------
@@ -2052,29 +2052,29 @@ class DGL:
             The desired type of model. The options are:
             - "Classifier"
             - "Regressor"
-            The option is case insensitive. The default is "classifierholdout"
+            The option is case insensitive. Default is "classifierholdout"
         optimizer : Optimizer
             The desired optimizer.
         cv_type : str , optional
-            The desired cross-validation method. This can be "Holdout" or "K-Fold". It is case-insensitive. The default is "Holdout".
+            The desired cross-validation method. This can be "Holdout" or "K-Fold". It is case-insensitive. Default is "Holdout".
         split : list , optional
-            The desired split between training validation, and testing. [0.8, 0.1, 0.1] means that 80% of the data is used for training 10% of the data is used for validation, and 10% is used for testing. The default is [0.8, 0.1, 0.1].
+            The desired split between training validation, and testing. [0.8, 0.1, 0.1] means that 80% of the data is used for training 10% of the data is used for validation, and 10% is used for testing. Default is [0.8, 0.1, 0.1].
         k_folds : int , optional
-            The desired number of k-folds. The default is 5.
+            The desired number of k-folds. Default is 5.
         hl_widths : list , optional
-            The list of hidden layer widths. A list of [16, 32, 16] means that the model will have 3 hidden layers with number of neurons in each being 16, 32, 16 respectively from input to output. The default is [32].
+            The list of hidden layer widths. A list of [16, 32, 16] means that the model will have 3 hidden layers with number of neurons in each being 16, 32, 16 respectively from input to output. Default is [32].
         conv_layer_type : str , optional
-            The desired type of the convolution layer. The options are "Classic", "GraphConv", "GINConv", "SAGEConv", "TAGConv", "DGN". It is case insensitive. The default is "SAGEConv".
+            The desired type of the convolution layer. The options are "Classic", "GraphConv", "GINConv", "SAGEConv", "TAGConv", "DGN". It is case insensitive. Default is "SAGEConv".
         pooling : str , optional
-            The desired type of pooling. The options are "AvgPooling", "MaxPooling", or "SumPooling". It is case insensitive. The default is "AvgPooling".
+            The desired type of pooling. The options are "AvgPooling", "MaxPooling", or "SumPooling". It is case insensitive. Default is "AvgPooling".
         batch_size : int , optional
-            The desired batch size. The default is 1.
+            The desired batch size. Default is 1.
         epochs : int , optional
-            The desired number of epochs. The default is 1.
+            The desired number of epochs. Default is 1.
         use_gpu : bool , optional
-            If set to True, the model will attempt to use the GPU. The default is False.
+            If set to True, the model will attempt to use the GPU. Default is False.
         loss_function : str , optional
-            The desired loss function. The options are "Cross-Entropy" or "Negative Log Likelihood". It is case insensitive. The default is "Cross-Entropy".
+            The desired loss function. The options are "Cross-Entropy" or "Negative Log Likelihood". It is case insensitive. Default is "Cross-Entropy".
 
         Returns
         -------
@@ -2146,7 +2146,7 @@ class DGL:
         dataset : DGLDataset
             The input dataset
         graphLabelHeader: str , optional
-            The key string under which the graph labels are stored. The default is "label".
+            The key string under which the graph labels are stored. Default is "label".
         
         Returns
         -------
@@ -2182,7 +2182,7 @@ class DGL:
         dataset : DGLDataset
             The input dataset
         graphFeaturesHeader: str , optional
-            The key string under which the graph features are stored. The default is "feat".
+            The key string under which the graph features are stored. Default is "feat".
         
         Returns
         -------
@@ -2287,7 +2287,7 @@ class DGL:
         dataset : DGLDataset
             The input dataset
         split : list , optional
-            A list of length 3 containing the fraction to use for training, validation and test. If None, we will use [0.8, 0.1, 0.1]. The default is [0.8, 0.1, 0.1]
+            A list of length 3 containing the fraction to use for training, validation and test. If None, we will use [0.8, 0.1, 0.1]. Default is [0.8, 0.1, 0.1]
         randomState :  int or array_like , optional
             Random seed used to initialize the pseudo-random number generator. Can be any integer between 0 and 2**32 - 1 inclusive, an array (or other sequence) of such integers, or None (the default). If seed is None, then RandomState will try to read data from /dev/urandom (or the Windows analogue) if available or seed from the clock otherwise.
         
@@ -2364,17 +2364,17 @@ class DGL:
         Parameters
         ----------
         amsgrad : bool , optional.
-            amsgrad is an extension to the Adam version of gradient descent that attempts to improve the convergence properties of the algorithm, avoiding large abrupt changes in the learning rate for each input variable. The default is True.
+            amsgrad is an extension to the Adam version of gradient descent that attempts to improve the convergence properties of the algorithm, avoiding large abrupt changes in the learning rate for each input variable. Default is True.
         betas : tuple , optional
-            Betas are used as for smoothing the path to the convergence also providing some momentum to cross a local minima or saddle point. The default is (0.9, 0.999).
+            Betas are used as for smoothing the path to the convergence also providing some momentum to cross a local minima or saddle point. Default is (0.9, 0.999).
         eps : float . optional.
-            eps is a term added to the denominator to improve numerical stability. The default is 0.000001.
+            eps is a term added to the denominator to improve numerical stability. Default is 0.000001.
         lr : float
-            The learning rate (lr) defines the adjustment in the weights of our network with respect to the loss gradient descent. The default is 0.001.
+            The learning rate (lr) defines the adjustment in the weights of our network with respect to the loss gradient descent. Default is 0.001.
         maximize : float , optional
-            maximize the params based on the objective, instead of minimizing. The default is False.
+            maximize the params based on the objective, instead of minimizing. Default is False.
         weightDecay : float , optional
-            weightDecay (L2 penalty) is a regularization technique applied to the weights of a neural network. The default is 0.0.
+            weightDecay (L2 penalty) is a regularization technique applied to the weights of a neural network. Default is 0.0.
 
         Returns
         -------
@@ -2403,7 +2403,7 @@ class DGL:
         model : Model
             The input trained model.
         nodeATTRKey : str , optional
-            The key used for node attributes. The default is "feat".
+            The key used for node attributes. Default is "feat".
 
         Returns
         -------
@@ -2443,7 +2443,7 @@ class DGL:
         model : Model
             The input trained model.
         nodeATTRKey : str , optional
-            The key used for node attributes. The default is "feat".
+            The key used for node attributes. Default is "feat".
     
         Returns
         -------
@@ -2573,23 +2573,23 @@ class DGL:
         labels : list
             The labels to use for the data.
         width : int , optional
-            The desired width of the figure. The default is 950.
+            The desired width of the figure. Default is 950.
         height : int , optional
-            The desired height of the figure. The default is 500.
+            The desired height of the figure. Default is 500.
         title : str , optional
-            The chart title. The default is "Training and Testing Results".
+            The chart title. Default is "Training and Testing Results".
         xTitle : str , optional
-            The X-axis title. The default is "Epochs".
+            The X-axis title. Default is "Epochs".
         xSpacing : float , optional
-            The X-axis spacing. The default is 1.0.
+            The X-axis spacing. Default is 1.0.
         yTitle : str , optional
-            The Y-axis title. The default is "Accuracy and Loss".
+            The Y-axis title. Default is "Accuracy and Loss".
         ySpacing : float , optional
-            The Y-axis spacing. The default is 0.1.
+            The Y-axis spacing. Default is 0.1.
         useMarkers : bool , optional
-            If set to True, markers will be displayed. The default is False.
+            If set to True, markers will be displayed. Default is False.
         chartType : str , optional
-            The desired type of chart. The options are "Line", "Bar", or "Scatter". It is case insensitive. The default is "Line".
+            The desired type of chart. The options are "Line", "Bar", or "Scatter". It is case insensitive. Default is "Line".
         backgroundColor : str , optional
             The desired background color. This can be any plotly color string and may be specified as:
             - A hex string (e.g. '#ff0000')
@@ -2607,15 +2607,15 @@ class DGL:
             - A named CSS color.
             The default is 'lightgray'.
         marginLeft : int , optional
-            The desired left margin in pixels. The default is 0.
+            The desired left margin in pixels. Default is 0.
         marginRight : int , optional
-            The desired right margin in pixels. The default is 0.
+            The desired right margin in pixels. Default is 0.
         marginTop : int , optional
-            The desired top margin in pixels. The default is 40.
+            The desired top margin in pixels. Default is 40.
         marginBottom : int , optional
-            The desired bottom margin in pixels. The default is 0.
+            The desired bottom margin in pixels. Default is 0.
         renderer : str , optional
-            The desired plotly renderer. The default is "notebook".
+            The desired plotly renderer. Default is "notebook".
 
         Returns
         -------
@@ -2737,7 +2737,7 @@ class DGL:
         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
         -------
@@ -2863,7 +2863,7 @@ class DGL:
         path : str
             The input BIN file path.
         graphLabelKey : str , optional
-            The graph label key to use. The default is "label".
+            The graph label key to use. Default is "label".
 
         Returns
         -------
@@ -2887,7 +2887,7 @@ class DGL:
         data : dict
             The input data. See Data(model)
         overwrite : bool , optional
-            If set to True, previous saved results files are overwritten. Otherwise, the new results are appended to the previously saved files. The default is False.
+            If set to True, previous saved results files are overwritten. Otherwise, the new results are appended to the previously saved files. Default is False.
 
         Returns
         -------
@@ -2955,7 +2955,7 @@ class DGL:
         predicted : list
             The input list of predicted values.
         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
         -------
@@ -2994,7 +2994,7 @@ class DGL:
         predicted : list
             The input list of predicted values.
         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
         -------
@@ -3038,7 +3038,7 @@ class DGL:
         testingDataset : DGLDataset
             The input testing dataset. If not specified, a portion of the trainingDataset will be used for testing according the to the split list as specified in the hyper-parameters.
         overwrite : bool , optional
-            If set to True, previous saved results files are overwritten. Otherwise, the new results are appended to the previously saved files. The default is False.
+            If set to True, previous saved results files are overwritten. Otherwise, the new results are appended to the previously saved files. Default is False.
 
         Returns
         -------

topologicpy/Dictionary.py

@@ -59,15 +59,15 @@ class Dictionary():
             The type of subTopology on which to base the adjacency dictionary.
         labelKey : str , optional
             The returned subTopologies are labelled according to the dictionary values stored under this key.
-            If the labelKey does not exist, it will be created and the subTopologies are labelled numerically and stored in the subTopologies' dictionary under this key. The default is None.
+            If the labelKey does not exist, it will be created and the subTopologies are labelled numerically and stored in the subTopologies' dictionary under this key. Default is None.
         weightKey : str , optional
-            If set, the sharedTopologies' dictionaries will be searched for this key to set their weight. If the key is set to "Area" or "Length" (case insensitive), the area of shared faces or the length of the shared edges will be used as its weight. If set to None, a weight of 1 will be used. The default is None.
+            If set, the sharedTopologies' dictionaries will be searched for this key to set their weight. If the key is set to "Area" or "Length" (case insensitive), the area of shared faces or the length of the shared edges will be used as its weight. If set to None, a weight of 1 will be used. Default is None.
         includeWeights : bool , optional
-            If set to True, edge weights are included. Otherwise, they are not. The default is False.
+            If set to True, edge weights are included. Otherwise, they are not. Default is False.
         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.
         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
         -------
@@ -178,7 +178,7 @@ class Dictionary():
         value : int, float, str, or list
             A value corresponding to the input key. A value can be an integer, a float, a string, or a list.
         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
         -------
@@ -249,7 +249,7 @@ class Dictionary():
         values : list
             A list of values corresponding to the list of keys. Values can be integers, floats, strings, or lists
         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
         -------
@@ -290,7 +290,7 @@ class Dictionary():
         dictionaries : list or comma separated dictionaries
             The input list of dictionaries to be merged.
         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
         -------
@@ -458,7 +458,7 @@ class Dictionary():
         pythonDictionary : dict
             The input python dictionary.
         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
         -------
@@ -513,11 +513,11 @@ class Dictionary():
         dictionaries : list
             The input list of dictionaries to be filtered.
         searchType : str , optional
-            The type of search query to conduct in the topology's dictionary. This can be one of "any", "equal to", "contains", "starts with", "ends with", "not equal to", "does not contain". The default is "any".
+            The type of search query to conduct in the topology's dictionary. This can be one of "any", "equal to", "contains", "starts with", "ends with", "not equal to", "does not contain". Default is "any".
         key : str , optional
-            The dictionary key to search within. The default is None which means it will filter by topology type only.
+            The dictionary key to search within. Default is None which means it will filter by topology type only.
         value : str , optional
-            The value to search for at the specified key. The default is None which means it will filter by topology type only.
+            The value to search for at the specified key. Default is None which means it will filter by topology type only.
 
         Returns
         -------
@@ -602,7 +602,7 @@ class Dictionary():
         dictionary : topologic_core.Dictionary or dict
             The input dictionary.
         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
         -------
@@ -657,7 +657,7 @@ class Dictionary():
         dictionary : topologic_core.Dictionary
             The input dictionary.
         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
         -------
@@ -710,7 +710,7 @@ class Dictionary():
         key : string
             The input key.
         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
         -------
@@ -769,7 +769,7 @@ class Dictionary():
         value : int , float , string, or list
             The value associated with the key.
         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
         -------
@@ -827,7 +827,7 @@ class Dictionary():
         values : list
             A list of values corresponding to the list of keys. Values can be integers, floats, strings, or lists
         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
         -------
@@ -942,9 +942,9 @@ class Dictionary():
         key : string
             The input key.
         defaultValue : any , optional
-            The default value to return if the key or value are not found. The default is None.
+            The default value to return if the key or value are not found. Default is None.
         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
         -------
@@ -979,7 +979,7 @@ class Dictionary():
         dictionary : topologic_core.Dictionary or dict
             The input dictionary.
         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
         -------
@@ -1025,9 +1025,9 @@ class Dictionary():
         keys : list
             The input list of keys.
         defaultValue : any , optional
-            The default value to return if the key or value are not found. The default is None.
+            The default value to return if the key or value are not found. Default is None.
         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
         -------