Fix doc-strings after big merge

superduper-io · May 21, 2024 · 3e30adf · 3e30adf
1 parent f823af1
commit 3e30adf
Show file tree

Hide file tree

Showing 493 changed files with 8,262 additions and 2,316 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -19,8 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - At the end of the test, drop the collection instead of the database
 - Force load vector indices during backfill
 - Fix pandas database (in-memory)
-- Add docstrings in component classes and methods.
-
+- Add and update docstrings in component classes and methods.
 
 #### New Features & Functionality
 - Add nightly image for pre-release testing in the cloud environment

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -97,6 +97,21 @@ These tests check that cluster mode works as expected (`ray`, `vector-search`, `
 make smoke_testing
 ```
 
+## Create an issue
+
+If you have an unsolvable problem or find a bug with the code, we
+would love it if you could create a useful [issue on GitHub](https://github.com/SuperDuperDB/superduperdb-stealth/issues).
+
+Creating a useful issue, is itself a useful skill. Think about following these pointers:
+
+- Add the "bug label" to flag the issue as a bug
+- Make sure the issue contains the ***minimal code*** needed to create the issue:
+  - Remove padding code, unnecessary setup etc. 
+  - Make it as easy as possible to recreate the problem.
+- Always include the traceback in the issue
+- To flag the issue to the team, escalate this in the Slack channels
+- Tag relevant people who have worked on that issue, or know the feature
+
 ## Getting Help 🙋
 
 [![Slack](https://img.shields.io/badge/Slack-superduperdb-8A2BE2?logo=slack)](https://join.slack.com/t/superduperdb/shared_invite/zt-1zuojj0k0-RjAYBs1TDsvEa7yaFGa6QA)

diff --git a/Makefile b/Makefile
@@ -48,8 +48,9 @@ new_release: ## Release a new version of SuperDuperDB
 	git push --set-upstream origin release-$(RELEASE_VERSION) --tags
 
 install_devkit: ## Add essential development tools
-	@echo "Download Docs dependencies"
-	python -m pip install --user sphinx furo myst_parser
+	# Add pre-commit hooks to ensure that no strange stuff are being committed.
+	# https://stackoverflow.com/questions/3462955/putting-git-hooks-into-a-repository
+	python -m pip install pre-commit
 
 	@echo "Download Code Quality dependencies"
 	python -m pip install --user black==23.3 ruff mypy types-PyYAML types-requests interrogate
@@ -61,18 +62,15 @@ install_devkit: ## Add essential development tools
 ##@ Code Quality
 
 gen_docs: ## Generate Docs and API
+	@echo "===> Generate API docs as Markdown <==="
+	python docs/hr/content/build_api_docs.py
+	@echo "Build finished. The HTML pages are in docs/hr/content/build_api_docs"
+
 	@echo "===> Generate docusaurus docs and blog-posts <==="
 	cd docs/hr && npm i --legacy-peer-deps && npm run build
 	cd ../..
 	@echo "Build finished. The HTML pages are in docs/hr/build"
 
-	@echo "===> Generate Sphinx HTML documentation, including API docs <==="
-	rm -rf docs/api/source/
-	rm -rf docs/hr/build/apidocs
-	sphinx-apidoc -f -o docs/api/source superduperdb
-	sphinx-build -a docs/api docs/hr/build/apidocs
-	@echo "Build finished. The HTML pages are in docs/hr/build/apidocs"
-
 lint-and-type-check: ## Lint and type-check the code
 	@echo "===> Code Formatting <==="
 	black --check $(DIRECTORIES)
@@ -229,4 +227,4 @@ ext_testing: ## Execute integration testing
 	pytest $(PYTEST_ARGUMENTS) ./test/integration/ext
 
 smoke_testing: ## Execute smoke testing
-	SUPERDUPERDB_CONFIG=deploy/testenv/env/smoke/config.yaml pytest $(PYTEST_ARGUMENTS) ./test/smoke
+	SUPERDUPERDB_CONFIG=deploy/testenv/env/smoke/config.yaml pytest $(PYTEST_ARGUMENTS) ./test/smoke
diff --git a/deploy/installations/testenv_requirements.txt b/deploy/installations/testenv_requirements.txt
@@ -16,3 +16,6 @@ scikit-learn>=1.1.3
 python-magic
 python-multipart
 anthropic>=0.25.0
+peft>=0.10.0
+trl>=0.8.0 
+unstructured[md]>=0.12.5
diff --git a/docs/hr/README.md → docs/README.md b/docs/hr/README.md → docs/README.md
diff --git a/docs/api/banner.txt b/docs/api/banner.txt
diff --git a/docs/api/conf.py b/docs/api/conf.py
diff --git a/docs/api/img/SuperDuperDB_logo.png b/docs/api/img/SuperDuperDB_logo.png
diff --git a/docs/api/index.md b/docs/api/index.md
diff --git a/docs/api/source/modules.rst b/docs/api/source/modules.rst
diff --git a/docs/api/source/superduperdb.base.rst b/docs/api/source/superduperdb.base.rst
diff --git a/docs/api/source/superduperdb.cli.rst b/docs/api/source/superduperdb.cli.rst
diff --git a/docs/api/source/superduperdb.container.rst b/docs/api/source/superduperdb.container.rst