Merge 7140e72 into ad8a0bd

examples/rov_whylogs/.gitignore

@@ -0,0 +1,129 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/

examples/rov_whylogs/.whylogs.yaml

@@ -0,0 +1,23 @@
+# .whylogs.yaml
+
+# Example WhyLogs YAML configuration
+project: example-project
+pipeline: example-pipeline
+verbose: false
+writers:
+# Save out the full protobuf datasketches data locally
+- formats:
+    - protobuf
+  output_path: whylogs-output
+  # Template variables can be accessed via $variable or ${variable}
+  path_template: $name/dataset_profile
+  filename_template: datase_profile-$dataset_timestamp
+  type: local
+# Save out the flat summary data locally, separately from the protobuf
+- formats:
+    - flat
+    - json
+  output_path: whylogs-output
+  path_template: $name/dataset_summary
+  filename_template: dataset_summary-$dataset_timestamp
+  type: local

examples/rov_whylogs/README.md

@@ -0,0 +1,13 @@
+# Fault Detection of an Underwater Drone with Kafka and whylogs
+
+This is the project's repository for the following article:
+
+
+You can follow along the post with the ROV-whylogs.ipynb. It has essentialy the same content. The only differences are that some pieces of code that are meant to run endlessly were changed to run only once in the notebook. Besides that, the code for the monitoring dashboard is present only in the notebook, while the results are discussed only in the blog content. 
+
+To start the kafka related container simply run:
+
+```
+docker-compose -f kafka_files/docker-compose.yml up -d   
+```
+