22322: Adds descriptions for undescribed parameters and updates out-of-date docstrings

howso.amlg

@@ -235,7 +235,7 @@
 		"react_utilities"
 		"remove_cases"
 		"residuals"
-		"return_typing"
+		"return_types"
 		"series_store"
 		"shared_deviations"
 		"substitution"
@@ -245,7 +245,7 @@
 		"synthesis_validation"
 		"train"
 		"train_ts_ablation"
-		"typing"
+		"types"
 		"update_cases"
 		"upgrade"
 	)

howso/analysis.amlg

@@ -88,6 +88,7 @@
 			; This incurs a penalty in speed, but can improve model performance in long tailed data, especially when using targetless parameters.
 			use_dynamic_deviations (false)
 			;{type "number" min 2}
+			;the number of cases to store within the subtrainee that is used to the deviations of the data around predictions
 			dynamic_deviations_subtrainee_size 500
 		)
 

howso/details.amlg

@@ -25,37 +25,7 @@
 	;	"action_features"
 	;  	"action_values"
 	;  	"context_values"
-	; and the following keys as appropriately requested:
-	;	"influential_cases"
-	;	"most_similar_cases"
-	;	"boundary_cases"
-	;	"categorical_action_probabilities"
-	;	"aggregated_categorical_action_probabilities"
-	;	"similarity_conviction"
-	;	"residual_conviction"
-	;	"residual_dissimilarity_conviction"
-	;	"feature_residuals_robust"
-	;	"feature_residuals_full"
-	;	"observational_errors"
-	;	"outlying_feature_values"
-	;	"feature_mda_robust"
-	;	"feature_mda_full"
-	;	"feature_mda_ex_post_robust"
-	;	"feature_mda_ex_post_full"
-	;	"feature_contributions_robust"
-	;	"feature_contributions_full"
-	;	"directional_feature_contributions_robust"
-	;	"directional_feature_contributions_full"
-	;	"case_mda_robust"
-	;	"case_mda_full"
-	;	"case_contributions_robust"
-	;	"case_contributions_full"
-	;	"case_feature_residuals_robust"
-	;	"case_feature_residuals_full"
-	;	"case_feature_residual_convictions_robust"
-	;	"case_feature_residual_convictions_full"
-	;	"hypothetical_values"
-	;	"distance_contribution"
+	; and the keys for any requested detail with their appropriate values. See the ReactResponse type for information on each requestable detail.
 	#!RetrieveAuditData
 	(declare
 		(assoc

howso/editing.amlg

@@ -304,6 +304,7 @@
 			;if specified ignores condition and returns cases for the specified session id
 			condition_session (null)
 			;{type "boolean"}
+			;if true, will overwrite any previously trained values under the same feature name
 			overwrite (true)
 			;{type "string"}
 			;the session id when this call is being made

howso/hyperparameters.amlg

@@ -780,9 +780,10 @@
 			;	default of two orders of magnitude using the universal scaling factor e
 			analyze_growth_factor 7.389056
 			;{type "list" values "string"}
-			;parameter for analyze
+			;the features to use as contexts in the analysis
 			context_features (null)
 			;{type "list" values "string"}
+			;the features that the analysis should target
 			action_features (null)
 			;{type "number" min 1}
 			;number of cross validation folds to do. value of 1 does hold-one-out instead of k-fold

howso/react.amlg

@@ -112,6 +112,18 @@
 			;						context features. If action features aren't specified, uses familiarity conviction to
 			;						determine the boundary instead.
 			;
+			; 		 "boundary_value_context_features" list of strings. When specified, outputs a map of each specified feature to
+			;		 				possible boundary values under "boundary_values". If 'boundary_value_action_outcome' is
+			;		 				unspecified, then the returned values are values where the ratio of change in action to total
+			;		 				change is maximized. If 'boundary_value_action_outcome' is specified, then the boundary values
+			;		 				represent the closest found values for each context feature that shift the action to fulfill the condition.
+			;
+			;		"boundary_value_action_outcome" assoc of action_feature -> condition. When specified, outputs a map of each specified feature
+			;						to possible boundary values under "boundary_values". If 'boundary_value_action_outcome' is unspecified, then
+			;						the returned values are values where the ratio of change in action to total change is maximized. If
+			;						'boundary_value_action_outcome' is specified, then the boundary values represent the closest found values for
+			;						each context feature that shift the action to fulfill the condition.
+			;
 			;		 "num_boundary_cases" integer. Outputs this manually specified number of boundary cases.
 			;
 			;		 'boundary_cases_familiarity_convictions" true or false. If true outputs familiarity conviction of addition for

unit_tests/ut_h_type_hints.amlg

@@ -72,6 +72,34 @@
         (call exit_if_failures (assoc
             msg (concat "Invalid Return Type Hints: " (apply "concat" (trunc (weave invalid_return_type_labels ", "))) )
         ))
+
+        (declare (assoc
+            undescribed_parameters
+                (apply
+                    "append"
+                    (values (map
+                        (lambda
+                            (map
+                                (lambda
+                                    (concat (current_index 1) "/" (current_value))
+                                )
+                                (indices (filter
+                                    (lambda
+                                        (= "" (get (current_value) "description"))
+                                    )
+                                    (get (current_value) "parameters")
+                                ))
+                            )
+                        )
+                        labels_map
+                    ))
+                )
+        ))
+        (print "No undescribed parameters: ")
+        (call assert_same (assoc exp 0 obs (size undescribed_parameters)))
+        (call exit_if_failures (assoc
+            msg (concat "Undescribed parameters: " (apply "concat" (trunc (weave undescribed_parameters ", "))) )
+        ))
     )