Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(docstring-readme): finish docstring and write readme #16

Merged
Merged
Prev Previous commit
Next Next commit
docs(example-notebook): start initial notebook for writing example
ninopleno committed Dec 4, 2023
commit cb08aa21f4c38c09f7f93e8b81211a4a12839b32
64 changes: 64 additions & 0 deletions docs/example.ipynb
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
{
"cells": [
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# **Anomaly Detection with Extreme Value Theory and POT Method**"
]
},
{
"cell_type": "code",
"execution_count": 3,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"Obtaining file:///Users/ninovation/Projects/Research/Anomalytics/docs\n",
"\u001b[31mERROR: file:///Users/ninovation/Projects/Research/Anomalytics/docs does not appear to be a Python project: neither 'setup.py' nor 'pyproject.toml' found.\u001b[0m\u001b[31m\n",
"\u001b[0m"
]
}
],
"source": [
"!pip3 install -e .[extra]"
]
},
{
"cell_type": "code",
"execution_count": 2,
"metadata": {},
"outputs": [],
"source": [
"import matplotlib.pyplot as plt\n",
"import numpy as np\n",
"import pandas as pd\n",
"\n",
"plt.style.use(\"bmh\")\n"
]
}
],
"metadata": {
"kernelspec": {
"display_name": "Python 3.12 (anomalytics)",
"language": "python",
"name": "anomalytics"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.12.0"
}
},
"nbformat": 4,
"nbformat_minor": 2
}