Commit with documentation updates

jwzhanggy · Nov 18, 2024 · 1b01959 · 1b01959
1 parent 422ad53
commit 1b01959
Show file tree

Hide file tree

Showing 282 changed files with 1,717 additions and 215 deletions.
diff --git a/docs/documentations/application/bat.md b/docs/documentations/application/bat.md
@@ -0,0 +1,3 @@
+# bat
+
+::: tinybig.application.bat
diff --git a/docs/documentations/application/cat.md b/docs/documentations/application/cat.md
@@ -0,0 +1,3 @@
+# cat
+
+::: tinybig.application.cat
diff --git a/docs/documentations/application/cheetah.md b/docs/documentations/application/cheetah.md
@@ -0,0 +1,3 @@
+# cheetah
+
+::: tinybig.application.cheetah
diff --git a/docs/documentations/application/chimpanzee.md b/docs/documentations/application/chimpanzee.md
@@ -0,0 +1,3 @@
+# chimpanzee
+
+::: tinybig.application.chimpanzee
diff --git a/docs/documentations/application/crow.md b/docs/documentations/application/crow.md
@@ -0,0 +1,3 @@
+# crow
+
+::: tinybig.application.crow
diff --git a/docs/documentations/application/eagle.md b/docs/documentations/application/eagle.md
@@ -0,0 +1,3 @@
+# eagle
+
+::: tinybig.application.eagle
diff --git a/docs/documentations/application/elephant.md b/docs/documentations/application/elephant.md
@@ -0,0 +1,3 @@
+# elephant
+
+::: tinybig.application.elephant
diff --git a/docs/documentations/application/index.md b/docs/documentations/application/index.md
@@ -0,0 +1,15 @@
+# tinybig.application
+
+::: tinybig.application
+
+---------------------------------------
+## Organization of this Module
+
+* [bat](bat.md)
+* [cat](cat.md)
+* [cheetah.md](cheetah.md)
+* [chimpanzee.md](chimpanzee.md)
+* [crow.md](crow.md)
+* [eagle.md](eagle.md)
+* [elephant.md](elephant.md)
+* [parrot.md](parrot.md)
diff --git a/docs/documentations/application/parrot.md b/docs/documentations/application/parrot.md
@@ -0,0 +1,3 @@
+# parrot
+
+::: tinybig.application.parrot
diff --git a/docs/documentations/compression/combinatorial_compression.md b/docs/documentations/compression/combinatorial_compression.md
@@ -0,0 +1,3 @@
+# combinatorial_compression
+
+::: tinybig.compression.combinatorial_compression.combinatorial_compression
diff --git a/docs/documentations/compression/combinatorial_probabilistic_compression.md b/docs/documentations/compression/combinatorial_probabilistic_compression.md
@@ -0,0 +1,3 @@
+# combinatorial_probabilistic_compression
+
+::: tinybig.compression.combinatorial_compression.combinatorial_probabilistic_compression
diff --git a/docs/documentations/compression/dimension_reduction_compression.md b/docs/documentations/compression/dimension_reduction_compression.md
@@ -0,0 +1,3 @@
+# dimension_reduction_compression
+
+::: tinybig.compression.dimension_reduction_compression.dimension_reduction_compression
diff --git a/docs/documentations/compression/extended_compression.md b/docs/documentations/compression/extended_compression.md
@@ -0,0 +1,3 @@
+# extended_compression
+
+::: tinybig.compression.extended_compression.extended_compression
diff --git a/docs/documentations/compression/feature_selection_compression.md b/docs/documentations/compression/feature_selection_compression.md
@@ -0,0 +1,3 @@
+# feature_selection_compression
+
+::: tinybig.compression.feature_selection_compression.feature_selection_compression
diff --git a/docs/documentations/compression/identity_compression.md b/docs/documentations/compression/identity_compression.md
@@ -0,0 +1,3 @@
+# identity_compression
+
+::: tinybig.compression.basic_compression.identity_compression
diff --git a/docs/documentations/compression/incremental_PCA_based_compression.md b/docs/documentations/compression/incremental_PCA_based_compression.md
@@ -0,0 +1,3 @@
+# incremental_PCA_based_compression
+
+::: tinybig.compression.dimension_reduction_compression.incremental_PCA_based_compression
diff --git a/.../documentations/compression/incremental_feature_clustering_based_compression.md b/.../documentations/compression/incremental_feature_clustering_based_compression.md
@@ -0,0 +1,3 @@
+# incremental_feature_clustering_based_compression
+
+::: tinybig.compression.feature_selection_compression.incremental_feature_clustering_based_compression
diff --git a/docs/documentations/compression/incremental_random_projection_based_compression.md b/docs/documentations/compression/incremental_random_projection_based_compression.md
@@ -0,0 +1,3 @@
+# incremental_random_projection_based_compression
+
+::: tinybig.compression.dimension_reduction_compression.incremental_random_projection_based_compression
diff --git a/.../documentations/compression/incremental_variance_threshold_based_compression.md b/.../documentations/compression/incremental_variance_threshold_based_compression.md
@@ -0,0 +1,3 @@
+# incremental_feature_clustering_based_compression
+
+::: tinybig.compression.feature_selection_compression.incremental_variance_threshold_based_compression
diff --git a/docs/documentations/compression/index.md b/docs/documentations/compression/index.md
@@ -0,0 +1,59 @@
+# tinybig.compression
+
+::: tinybig.compression
+
+---------------------------------------
+## Organization of this Module
+
+### Data Expansion/Transformation
+* [transformation](../module/transformation.md) (defined in the tinybig.module directory)
+
+### Basic Compressions
+* [identity_compression.md](identity_compression.md)
+* [reciprocal_compression.md](reciprocal_compression.md)
+* [linear_compression.md](linear_compression.md)
+
+### Metric based Compressions
+* [metric_compression.md](metric_compression.md)
+* [max_compression.md](max_compression.md)
+* [min_compression.md](min_compression.md)
+* [sum_compression.md](sum_compression.md)
+* [prod_compression.md](prod_compression.md)
+* [mean_compression.md](mean_compression.md)
+* [median_compression.md](median_compression.md)
+
+### Feature Selection based Compressions
+* [feature_selection_compression.md](feature_selection_compression.md)
+* [incremental_feature_clustering_based_compression.md](incremental_feature_clustering_based_compression.md)
+* [incremental_variance_threshold_based_compression.md](incremental_variance_threshold_based_compression.md)
+
+### Dimension Reduction based Compressions
+* [dimension_reduction_compression.md](dimension_reduction_compression.md)
+* [incremental_PCA_based_compression.md](incremental_PCA_based_compression.md)
+* [incremental_random_projection_based_compression.md](incremental_random_projection_based_compression.md)
+
+### Manifold based Compressions
+* [manifold_compression.md](manifold_compression.md)
+* [isomap_manifold_compression.md](isomap_manifold_compression.md)
+* [lle_manifold_compression.md](lle_manifold_compression.md)
+* [mds_manifold_compression.md](mds_manifold_compression.md)
+* [spectral_embedding_manifold_compression.md](spectral_embedding_manifold_compression.md)
+* [tsne_manifold_compression.md](tsne_manifold_compression.md)
+
+### Naive Probabilistic Compressions
+* [naive_probabilistic_compression.md](naive_probabilistic_compression.md)
+* [naive_uniform_probabilistic_compression.md](naive_uniform_probabilistic_compression.md)
+* [naive_normal_probabilistic_compression.md](naive_normal_probabilistic_compression.md)
+* [naive_cauchy_probabilistic_compression.md](naive_cauchy_probabilistic_compression.md)
+* [naive_chi2_probabilistic_compression.md](naive_chi2_probabilistic_compression.md)
+* [naive_exponential_probabilistic_compression.md](naive_exponential_probabilistic_compression.md)
+* [naive_gamma_probabilistic_compression.md](naive_gamma_probabilistic_compression.md)
+* [naive_laplace_probabilistic_compression.md](naive_laplace_probabilistic_compression.md)
+
+### Combinatorial Probabilistic Compressions
+* [combinatorial_compression.md](combinatorial_compression.md)
+* [combinatorial_probabilistic_compression.md](combinatorial_probabilistic_compression.md)
+
+### Nested and Extended Compressions
+* [nested_compression.md](nested_compression.md)
+* [extended_compression.md](extended_compression.md)
diff --git a/docs/documentations/compression/isomap_manifold_compression.md b/docs/documentations/compression/isomap_manifold_compression.md
@@ -0,0 +1,3 @@
+# isomap_manifold_compression
+
+::: tinybig.compression.manifold_compression.isomap_manifold_compression
diff --git a/docs/documentations/compression/linear_compression.md b/docs/documentations/compression/linear_compression.md
@@ -0,0 +1,3 @@
+# linear_compression
+
+::: tinybig.compression.basic_compression.linear_compression
diff --git a/docs/documentations/compression/lle_manifold_compression.md b/docs/documentations/compression/lle_manifold_compression.md
@@ -0,0 +1,3 @@
+# lle_manifold_compression
+
+::: tinybig.compression.manifold_compression.lle_manifold_compression
diff --git a/docs/documentations/compression/manifold_compression.md b/docs/documentations/compression/manifold_compression.md
@@ -0,0 +1,3 @@
+# manifold_compression
+
+::: tinybig.compression.manifold_compression.manifold_compression
diff --git a/docs/documentations/compression/max_compression.md b/docs/documentations/compression/max_compression.md
@@ -0,0 +1,3 @@
+# max_compression
+
+::: tinybig.compression.metric_based_compression.max_compression
diff --git a/docs/documentations/compression/mds_manifold_compression.md b/docs/documentations/compression/mds_manifold_compression.md
@@ -0,0 +1,3 @@
+# mds_manifold_compression
+
+::: tinybig.compression.manifold_compression.mds_manifold_compression
diff --git a/docs/documentations/compression/mean_compression.md b/docs/documentations/compression/mean_compression.md
@@ -0,0 +1,3 @@
+# mean_compression
+
+::: tinybig.compression.metric_based_compression.mean_compression
diff --git a/docs/documentations/compression/median_compression.md b/docs/documentations/compression/median_compression.md
@@ -0,0 +1,3 @@
+# median_compression
+
+::: tinybig.compression.metric_based_compression.median_compression
diff --git a/docs/documentations/compression/metric_compression.md b/docs/documentations/compression/metric_compression.md
@@ -0,0 +1,3 @@
+# metric_compression
+
+::: tinybig.compression.metric_based_compression.metric_compression
diff --git a/docs/documentations/compression/min_compression.md b/docs/documentations/compression/min_compression.md
@@ -0,0 +1,3 @@
+# min_compression
+
+::: tinybig.compression.metric_based_compression.min_compression
diff --git a/docs/documentations/compression/naive_cauchy_probabilistic_compression.md b/docs/documentations/compression/naive_cauchy_probabilistic_compression.md
@@ -0,0 +1,3 @@
+# naive_cauchy_probabilistic_compression
+
+::: tinybig.compression.probabilistic_compression.naive_cauchy_probabilistic_compression
diff --git a/docs/documentations/compression/naive_chi2_probabilistic_compression.md b/docs/documentations/compression/naive_chi2_probabilistic_compression.md
@@ -0,0 +1,3 @@
+# naive_chi2_probabilistic_compression
+
+::: tinybig.compression.probabilistic_compression.naive_chi2_probabilistic_compression
diff --git a/docs/documentations/compression/naive_exponential_probabilistic_compression.md b/docs/documentations/compression/naive_exponential_probabilistic_compression.md
@@ -0,0 +1,3 @@
+# naive_exponential_probabilistic_compression
+
+::: tinybig.compression.probabilistic_compression.naive_exponential_probabilistic_compression
diff --git a/docs/documentations/compression/naive_gamma_probabilistic_compression.md b/docs/documentations/compression/naive_gamma_probabilistic_compression.md
@@ -0,0 +1,3 @@
+# naive_gamma_probabilistic_compression
+
+::: tinybig.compression.probabilistic_compression.naive_gamma_probabilistic_compression
diff --git a/docs/documentations/compression/naive_laplace_probabilistic_compression.md b/docs/documentations/compression/naive_laplace_probabilistic_compression.md
@@ -0,0 +1,3 @@
+# naive_laplace_probabilistic_compression
+
+::: tinybig.compression.probabilistic_compression.naive_laplace_probabilistic_compression
diff --git a/docs/documentations/compression/naive_normal_probabilistic_compression.md b/docs/documentations/compression/naive_normal_probabilistic_compression.md
@@ -0,0 +1,3 @@
+# naive_normal_probabilistic_compression
+
+::: tinybig.compression.probabilistic_compression.naive_normal_probabilistic_compression
diff --git a/docs/documentations/compression/naive_probabilistic_compression.md b/docs/documentations/compression/naive_probabilistic_compression.md
@@ -0,0 +1,3 @@
+# naive_probabilistic_compression
+
+::: tinybig.compression.probabilistic_compression.naive_probabilistic_compression
diff --git a/docs/documentations/compression/naive_uniform_probabilistic_compression.md b/docs/documentations/compression/naive_uniform_probabilistic_compression.md
@@ -0,0 +1,3 @@
+# naive_uniform_probabilistic_compression
+
+::: tinybig.compression.probabilistic_compression.naive_uniform_probabilistic_compression
diff --git a/docs/documentations/compression/nested_compression.md b/docs/documentations/compression/nested_compression.md
@@ -0,0 +1,3 @@
+# nested_compression
+
+::: tinybig.compression.nested_compression.nested_compression
diff --git a/docs/documentations/compression/prod_compression.md b/docs/documentations/compression/prod_compression.md
@@ -0,0 +1,3 @@
+# prod_compression
+
+::: tinybig.compression.metric_based_compression.prod_compression
diff --git a/docs/documentations/compression/reciprocal_compression.md b/docs/documentations/compression/reciprocal_compression.md
@@ -0,0 +1,3 @@
+# reciprocal_compression
+
+::: tinybig.compression.basic_compression.reciprocal_compression
diff --git a/docs/documentations/compression/spectral_embedding_manifold_compression.md b/docs/documentations/compression/spectral_embedding_manifold_compression.md
@@ -0,0 +1,3 @@
+# spectral_embedding_manifold_compression
+
+::: tinybig.compression.manifold_compression.spectral_embedding_manifold_compression
diff --git a/docs/documentations/compression/sum_compression.md b/docs/documentations/compression/sum_compression.md
@@ -0,0 +1,3 @@
+# sum_compression
+
+::: tinybig.compression.metric_based_compression.sum_compression
diff --git a/docs/documentations/compression/tsne_manifold_compression.md b/docs/documentations/compression/tsne_manifold_compression.md
@@ -0,0 +1,3 @@
+# tsne_manifold_compression
+
+::: tinybig.compression.manifold_compression.tsne_manifold_compression
diff --git a/docs/documentations/config/function_configs.md b/docs/documentations/config/function_configs.md
@@ -0,0 +1,3 @@
+# function_configs
+
+::: tinybig.config.function_configs.function_configs
diff --git a/docs/documentations/config/function_list_configs.md b/docs/documentations/config/function_list_configs.md
@@ -0,0 +1,3 @@
+# function_list_configs
+
+::: tinybig.config.function_configs.function_list_configs
diff --git a/docs/documentations/config/head_configs.md b/docs/documentations/config/head_configs.md
@@ -0,0 +1,3 @@
+# head_configs
+
+::: tinybig.config.head_configs.head_configs
diff --git a/docs/documentations/config/index.md b/docs/documentations/config/index.md
@@ -5,5 +5,16 @@
 ---------------------------------------
 ## Organization of this Module
 
+### Base Configs
 * [config](config.md)
-* [rpn_config](rpn_config.md)
+
+### Model Configs
+* [model_configs](model_configs.md)
+
+### Module Configs
+* [layer_configs](layer_configs.md)
+* [head_configs](head_configs.md)
+
+### Function Configs
+* [function_configs](function_configs.md)
+* [function_list_configs](function_list_configs.md)
diff --git a/docs/documentations/config/layer_configs.md b/docs/documentations/config/layer_configs.md
@@ -0,0 +1,3 @@
+# layer_configs
+
+::: tinybig.config.layer_configs.layer_configs
diff --git a/docs/documentations/config/model_configs.md b/docs/documentations/config/model_configs.md
@@ -0,0 +1,3 @@
+# model_configs
+
+::: tinybig.config.model_configs.model_configs
diff --git a/docs/documentations/config/rpn_config.md b/docs/documentations/config/rpn_config.md
diff --git a/docs/documentations/data/citeseer.md b/docs/documentations/data/citeseer.md
@@ -0,0 +1,2 @@
+# citeseer
+::: tinybig.data.graph_dataloader.citeseer
diff --git a/docs/documentations/data/cora.md b/docs/documentations/data/cora.md
@@ -0,0 +1,2 @@
+# cora
+::: tinybig.data.graph_dataloader.cora
diff --git a/docs/documentations/data/etf.md b/docs/documentations/data/etf.md
@@ -0,0 +1,3 @@
+# etf
+
+::: tinybig.data.time_series_dataloader.etf
diff --git a/docs/documentations/data/graph_dataloader.md b/docs/documentations/data/graph_dataloader.md
@@ -0,0 +1,2 @@
+# graph_dataloader
+::: tinybig.data.graph_dataloader.graph_dataloader
diff --git a/docs/documentations/data/index.md b/docs/documentations/data/index.md
@@ -27,13 +27,25 @@
 * [sst2](sst2.md)
 * [agnews](agnews.md)
 
+### Graph Data
+* [graph_dataloader](graph_dataloader.md)
+* [cora](cora.md)
+* [citeseer](citeseer.md)
+* [pubmed](pubmed.md)
+
+### Time-series Data
+* [time_series_dataloader](time_series_dataloader.md)
+* [stock](stock.md)
+* [etf](etf.md)
+* [traffic_la](traffic_la.md)
+* [traffic_bay](traffic_bay.md)
+
 ### Tabular Data
 * [tabular_dataloader](tabular_dataloader.md)
 * [iris](iris.md)
 * [diabetes](diabetes.md)
 * [banknote](banknote.md)
 
-<!-- ## Graph Data -->
 
 
 
diff --git a/docs/documentations/data/pubmed.md b/docs/documentations/data/pubmed.md
@@ -0,0 +1,2 @@
+# pubmed
+::: tinybig.data.graph_dataloader.pubmed
diff --git a/docs/documentations/data/stock.md b/docs/documentations/data/stock.md
@@ -0,0 +1,3 @@
+# stock
+
+::: tinybig.data.time_series_dataloader.stock
diff --git a/docs/documentations/data/time_series_dataloader.md b/docs/documentations/data/time_series_dataloader.md
@@ -0,0 +1,3 @@
+# time_series_dataloader
+
+::: tinybig.data.time_series_dataloader.time_series_dataloader
diff --git a/docs/documentations/data/traffic_bay.md b/docs/documentations/data/traffic_bay.md
@@ -0,0 +1,3 @@
+# traffic_bay
+
+::: tinybig.data.time_series_dataloader.traffic_bay
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# chimpanzee

		::: tinybig.application.chimpanzee
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# combinatorial_compression

		::: tinybig.compression.combinatorial_compression.combinatorial_compression
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# combinatorial_probabilistic_compression

		::: tinybig.compression.combinatorial_compression.combinatorial_probabilistic_compression
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# dimension_reduction_compression

		::: tinybig.compression.dimension_reduction_compression.dimension_reduction_compression
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# extended_compression

		::: tinybig.compression.extended_compression.extended_compression
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# feature_selection_compression

		::: tinybig.compression.feature_selection_compression.feature_selection_compression
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# identity_compression

		::: tinybig.compression.basic_compression.identity_compression
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# incremental_PCA_based_compression

		::: tinybig.compression.dimension_reduction_compression.incremental_PCA_based_compression
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# incremental_feature_clustering_based_compression

		::: tinybig.compression.feature_selection_compression.incremental_feature_clustering_based_compression
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# incremental_random_projection_based_compression

		::: tinybig.compression.dimension_reduction_compression.incremental_random_projection_based_compression