Merge branch 'dev'

Author: MegamindHenry

docs/make.jl

@@ -13,6 +13,7 @@ makedocs(;
     ),
     pages=[
         "Home" => "index.md",
+        "Test Combo Introduction" => "test_combo_intro.md",
         "Manual" => Any[
             "Make Cue Matrix" => "man/make_cue_matrix.md",
             "Make Semantic Matrix" => "man/make_semantic_matrix.md",
@@ -23,7 +24,11 @@ makedocs(;
             "Evaluation" => "man/eval.md",
             "Output" => "man/output.md",
             "Test Combo" => "man/test_combo.md",
-            "Utils" => "man/utils.md"
+            "Display" => "man/display.md",
+            "Utils" => "man/utils.md",
+            "Pickle" => "man/pickle.md",
+            "Pyndl" => "man/pyndl.md",
+            "Widrow-Hoff Learning" => "man/wh.md",
         ],
         "All Manual index" => "man/all_manual.md"
     ],

docs/src/index.md

@@ -0,0 +1,10 @@
+```@meta
+CurrentModule = JudiLing
+```
+
+# Cholesky
+
+```@docs
+    display_matrix(M, rownames, colnames)
+    display_matrix(data, target_col, cue_obj, M, M_type)
+```

docs/src/man/display.md

@@ -2,7 +2,7 @@
 CurrentModule = JudiLing
 ```
 
-# Find Paths
+# Evaluation
 
 ```@docs
     Comp_Acc_Struct
@@ -16,7 +16,8 @@ CurrentModule = JudiLing
     eval_SC_loose(SChat, SC, k)
     eval_SC_loose(SChat, SC, k, data, target_col)
     eval_manual(res, data, i2f)
-    eval_acc(res, gold_inds)
+    eval_acc(res, gold_inds::Array)
+    eval_acc(res, cue_obj::Cue_Matrix_Struct)
     eval_acc_loose(res, gold_inds)
     extract_gpi(gpi, threshold=0.1, tolerance=(-1000.0))
 ```

docs/src/man/eval.md

@@ -7,6 +7,9 @@ CurrentModule = JudiLing
 ```@docs
     Result_Path_Info_Struct
     Gold_Path_Info_Struct
+    learn_paths
+    build_paths
+    learn_paths(data, cue_obj, S_val, F_train, Chat_val)
     learn_paths(data_train, data_val, C_train, S_val, F_train, Chat_val, A, i2f, f2i)
     build_paths(data_val, C_train, S_val, F_train, Chat_val, A, i2f, C_train_ind)
     eval_can(candidates, S, F, i2f, max_can, if_pca, pca_eval_M)

docs/src/man/find_path.md

@@ -14,5 +14,5 @@ CurrentModule = JudiLing
     make_cue_matrix(data_train::DataFrame, data_val::DataFrame)
     make_cue_matrix(data::DataFrame, pyndl_weights::Pyndl_Weight_Struct)
     make_combined_cue_matrix(data_train, data_val)
-    make_ngrams(tokens, grams=3, keep_sep=false, sep_token=nothing, start_end_token="#")
+    make_ngrams(tokens, grams, keep_sep, sep_token, start_end_token)
 ```

docs/src/man/make_cue_matrix.md

@@ -7,12 +7,12 @@ CurrentModule = JudiLing
 ```@docs
     write2csv
     write2df
-    save_L_matrix
-    load_L_matrix
     write2csv(res, data, cue_obj_train, cue_obj_val, filename)
     write2csv(gpi, filename)
     write2df(res, data, cue_obj_train, cue_obj_val)
     write2df(gpi)
     save_L_matrix(L, filename)
     load_L_matrix(filename)
+    save_S_matrix(S, filename, data, target_col)
+    load_S_matrix(filename)
 ```

docs/src/man/output.md

@@ -5,6 +5,6 @@ CurrentModule = JudiLing
 # Utils
 
 ```@docs
-    mypickle
-    myunpickle
+    save_pickle
+    load_pickle
 ```

docs/src/man/pickle.md

@@ -5,10 +5,9 @@ CurrentModule = JudiLing
 # Preprocess
 
 ```@docs
-    lpo_cv_split
-    loo_cv_split
+    SplitDataException
     lpo_cv_split(p, data_path)
     loo_cv_split(data_path)
     train_val_random_split(data_path, output_dir_path, data_prefix)
-    train_val_carefully_split(data_path, output_dir_path, data_prefix, n_features_columns)
+    train_val_careful_split(data_path, output_dir_path, data_prefix, n_features_columns)
 ```

docs/src/man/preprocess.md

@@ -0,0 +1,10 @@
+```@meta
+CurrentModule = JudiLing
+```
+
+# Preprocess
+
+```@docs
+    Pyndl_Weight_Struct
+    pyndl(data_path)
+```