docs: util & loss

kozistr · Sep 10, 2023 · 6567b3e · 6567b3e
1 parent 78d76aa
commit 6567b3e
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 118 deletions.
diff --git a/docs/base_api.rst b/docs/base_api.rst
diff --git a/docs/loss.md b/docs/loss.md
@@ -1 +1,55 @@
-# Loss
+# Loss Function
+
+::: pytorch_optimizer.loss.bi_tempered.bi_tempered_logistic_loss
+    :docstring:
+
+::: pytorch_optimizer.BiTemperedLogisticLoss
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.BinaryBiTemperedLogisticLoss
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.BCELoss
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.SoftF1Loss
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.FocalLoss
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.FocalCosineLoss
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.BCEFocalLoss
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.FocalTverskyLoss
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.loss.jaccard.soft_jaccard_score
+    :docstring:
+
+::: pytorch_optimizer.JaccardLoss
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.LDAMLoss
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.LovaszHingeLoss
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.TverskyLoss
+    :docstring:
+    :members:
diff --git a/docs/loss_api.rst b/docs/loss_api.rst
diff --git a/docs/util.md b/docs/util.md
@@ -1 +1,3 @@
-# Util
+# Utilization
+
+