add pre-commit to dev req, docs update (#130)

* added SSL documentation and RTD PR preview

* fixed docs warnings

* excluding docs from pre-commit

* pre-commit fix

* pre-commit req and doc changes

docs/apidocs_common.md

@@ -1,27 +1,71 @@
 ## Layers
 
 ::: pytorch_tabular.models.common.layers.AddNorm
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.common.layers.Embedding1dLayer
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.common.layers.Embedding2dLayer
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.common.layers.Lambda
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.common.layers.ModuleWithInit
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.common.layers.MultiHeadedAttention
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.common.layers.PositionWiseFeedForward
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.common.layers.PreEncoded1dLayer
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.common.layers.Residual
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.common.layers.SharedEmbeddings
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.common.layers.TransformerEncoderBlock
+    options:
+            heading_level: 3
 
 ## Activations
 
 ::: pytorch_tabular.models.common.activations.Entmax15Function
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.common.activations.Entmoid15
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.common.activations.GEGLU
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.common.activations.PositionWiseFeedForward
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.common.activations.ReGLU
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.common.activations.SparsemaxFunction
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.common.activations.SwiGLU
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.common.activations.entmax15
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.common.activations.entmoid15
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.common.activations.sparsemax
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.common.activations.sparsemoid
+    options:
+            heading_level: 3

docs/apidocs_config.md

@@ -1,14 +1,36 @@
 # Configurations
 
+## Core Configuration
+
 ::: pytorch_tabular.config.DataConfig
+    options:
+            heading_level: 3
 ::: pytorch_tabular.config.ModelConfig
+    options:
+            heading_level: 3
 ::: pytorch_tabular.config.SSLModelConfig
+    options:
+            heading_level: 3
 ::: pytorch_tabular.config.TrainerConfig
+    options:
+            heading_level: 3
 ::: pytorch_tabular.config.ExperimentConfig
+    options:
+            heading_level: 3
 ::: pytorch_tabular.config.OptimizerConfig
+    options:
+            heading_level: 3
 ::: pytorch_tabular.config.ExperimentRunManager
+    options:
+            heading_level: 3
+
+## Head Configuration  
 
 In addition to these core classes, we also have config classes for heads
 
 ::: pytorch_tabular.models.common.heads.LinearHeadConfig
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.common.heads.MixtureDensityHeadConfig
+    options:
+            heading_level: 3

docs/apidocs_coreclasses.md

@@ -1,4 +1,8 @@
 # Core Classes
 
 ::: pytorch_tabular.TabularModel
+    options:
+            heading_level: 3
 ::: pytorch_tabular.TabularDatamodule
+    options:
+            heading_level: 3

docs/apidocs_head.md

@@ -1,9 +1,17 @@
 ## Configuration Classes
 
 ::: pytorch_tabular.models.common.heads.LinearHeadConfig
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.common.heads.MixtureDensityHeadConfig
+    options:
+            heading_level: 3
 
 ## Head Classes
 
 ::: pytorch_tabular.models.common.heads.LinearHead
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.common.heads.MixtureDensityHead
+    options:
+            heading_level: 3

docs/apidocs_model.md

@@ -1,23 +1,61 @@
 ## Configuration Classes
 
 ::: pytorch_tabular.models.AutoIntConfig
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.CategoryEmbeddingModelConfig
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.FTTransformerConfig
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.GatedAdditiveTreeEnsembleConfig
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.MDNConfig
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.NodeConfig
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.TabNetModelConfig
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.TabTransformerConfig
+    options:
+            heading_level: 3
 ::: pytorch_tabular.config.ModelConfig
+    options:
+            heading_level: 3
 
 ## Model Classes
 
 ::: pytorch_tabular.models.AutoIntModel
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.CategoryEmbeddingModel
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.FTTransformerModel
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.GatedAdditiveTreeEnsembleModel
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.MDNModel
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.NODEModel
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.TabNetModel
+    options:
+            heading_level: 3
 ::: pytorch_tabular.models.TabTransformerModel
+    options:
+            heading_level: 3
+
+## Base Model Class
 ::: pytorch_tabular.models.BaseModel
+    options:
+            heading_level: 3

docs/apidocs_ssl.md

@@ -1,9 +1,16 @@
 ## Configuration Classes
 
 ::: pytorch_tabular.ssl_models.DenoisingAutoEncoderConfig
+    options:
+            heading_level: 3
 
 ## Model Classes
 
 ::: pytorch_tabular.ssl_models.DenoisingAutoEncoderModel
+    options:
+            heading_level: 3
 
+## Base Model Class
 ::: pytorch_tabular.ssl_models.SSLBaseModel
+    options:
+            heading_level: 3

docs/apidocs_utils.md

@@ -1,13 +1,35 @@
 # Utilities
 
+## Special Feature Classes
 ::: pytorch_tabular.CategoricalEmbeddingTransformer
+    options:
+            heading_level: 3
 ::: pytorch_tabular.DeepFeatureExtractor
+    options:
+            heading_level: 3
 
+## Miscllaneous Utilities
 ::: pytorch_tabular.utils._initialize_layers
+    options:
+            heading_level: 3
 ::: pytorch_tabular.utils._linear_dropout_bn
+    options:
+            heading_level: 3
 ::: pytorch_tabular.utils._make_smooth_weights_for_balanced_classes
+    options:
+            heading_level: 3
 ::: pytorch_tabular.utils.get_balanced_sampler
+    options:
+            heading_level: 3
 ::: pytorch_tabular.utils.get_class_weighted_cross_entropy
+    options:
+            heading_level: 3
 ::: pytorch_tabular.utils.get_gaussian_centers
+    options:
+            heading_level: 3
 ::: pytorch_tabular.utils.getattr_nested
+    options:
+            heading_level: 3
 ::: pytorch_tabular.utils.ifnone
+    options:
+            heading_level: 3

docs/authors.md

@@ -2,8 +2,9 @@
 
 ## Development Lead
 
-- Manu Joseph <[email protected]>
+- [Manu Joseph](https://github.com/manujosephv) | Email: [[email protected]](mailto:[email protected]) | [LinkedIn](https://linkedin.com/in/in/manujosephv) | [Twitter](https://twitter.com/manujosephv) | [Blog](https://github.com/manujosephv/manujosephv/blob/main/https:/deep-and-shallow.com/feed)
 
 ## Contributors
 
-None yet. Why not be the first?
+- [Jirka Borovec](https://github.com/Borda)
+