aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/api/model.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/api/model.md')
-rw-r--r--docs/api/model.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/api/model.md b/docs/api/model.md
new file mode 100644
index 00000000..406d24be
--- /dev/null
+++ b/docs/api/model.md
@@ -0,0 +1,42 @@
+# Model package
+
+```{eval-rst}
+.. automodule:: sec_certs.model
+ :no-members:
+```
+
+```{tip}
+The examples related to this package can be found at [model notebook](./../notebooks/examples/model.ipynb).
+```
+
+## CPEClassifier
+
+```{eval-rst}
+.. currentmodule:: sec_certs.model
+.. autoclass:: CPEClassifier
+ :members:
+```
+
+## SARTranformer
+
+```{eval-rst}
+.. currentmodule:: sec_certs.model
+.. autoclass:: SARTransformer
+ :members:
+```
+
+## DependencyFinder
+
+```{eval-rst}
+.. currentmodule:: sec_certs.model
+.. autoclass:: DependencyFinder
+ :members:
+```
+
+## DependencyVulnerabilityFinder
+
+```{eval-rst}
+.. currentmodule:: sec_certs.model
+.. autoclass:: DependencyVulnerabilityFinder
+ :members:
+``` \ No newline at end of file