version 0 of sphinx doc

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,30 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'Intelligence Layer☯️'
+copyright = '2023, Aleph Alpha'
+author = 'Aleph Alpha'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'sphinx.ext.napoleon']
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../src'))
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'alabaster'
+html_static_path = ['_static']

docs/index.rst

@@ -0,0 +1,20 @@
+.. Intelligence Layer☯️ documentation master file, created by
+   sphinx-quickstart on Fri Oct 27 12:44:30 2023.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Intelligence Layer☯️'s documentation!
+================================================
+
+.. toctree::
+   :maxdepth: 9
+   :caption: Contents:
+
+   modules
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/intelligence_layer.connectors.retrievers.rst

@@ -0,0 +1,37 @@
+intelligence\_layer.connectors.retrievers package
+=================================================
+
+Submodules
+----------
+
+intelligence\_layer.connectors.retrievers.base\_retriever module
+----------------------------------------------------------------
+
+.. automodule:: intelligence_layer.connectors.retrievers.base_retriever
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+intelligence\_layer.connectors.retrievers.document\_index\_retriever module
+---------------------------------------------------------------------------
+
+.. automodule:: intelligence_layer.connectors.retrievers.document_index_retriever
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+intelligence\_layer.connectors.retrievers.in\_memory\_retriever module
+----------------------------------------------------------------------
+
+.. automodule:: intelligence_layer.connectors.retrievers.in_memory_retriever
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: intelligence_layer.connectors.retrievers
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/intelligence_layer.connectors.rst

@@ -0,0 +1,29 @@
+intelligence\_layer.connectors package
+======================================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   intelligence_layer.connectors.retrievers
+
+Submodules
+----------
+
+intelligence\_layer.connectors.document\_index module
+-----------------------------------------------------
+
+.. automodule:: intelligence_layer.connectors.document_index
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: intelligence_layer.connectors
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/intelligence_layer.core.rst

@@ -0,0 +1,77 @@
+intelligence\_layer.core package
+================================
+
+Submodules
+----------
+
+intelligence\_layer.core.complete module
+----------------------------------------
+
+.. automodule:: intelligence_layer.core.complete
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+intelligence\_layer.core.echo module
+------------------------------------
+
+.. automodule:: intelligence_layer.core.echo
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+intelligence\_layer.core.evaluator module
+-----------------------------------------
+
+.. automodule:: intelligence_layer.core.evaluator
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+intelligence\_layer.core.explain module
+---------------------------------------
+
+.. automodule:: intelligence_layer.core.explain
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+intelligence\_layer.core.logger module
+--------------------------------------
+
+.. automodule:: intelligence_layer.core.logger
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+intelligence\_layer.core.prompt\_template module
+------------------------------------------------
+
+.. automodule:: intelligence_layer.core.prompt_template
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+intelligence\_layer.core.task module
+------------------------------------
+
+.. automodule:: intelligence_layer.core.task
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+intelligence\_layer.core.text\_highlight module
+-----------------------------------------------
+
+.. automodule:: intelligence_layer.core.text_highlight
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: intelligence_layer.core
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/intelligence_layer.rst

@@ -0,0 +1,7 @@
+My Title
+*********
+
+.. automodule:: intelligence_layer
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/intelligence_layer.use_cases.classify.rst

@@ -0,0 +1,21 @@
+intelligence\_layer.use\_cases.classify package
+===============================================
+
+Submodules
+----------
+
+intelligence\_layer.use\_cases.classify.single\_label\_classify module
+----------------------------------------------------------------------
+
+.. automodule:: intelligence_layer.use_cases.classify.single_label_classify
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: intelligence_layer.use_cases.classify
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/intelligence_layer.use_cases.qa.rst

@@ -0,0 +1,45 @@
+intelligence\_layer.use\_cases.qa package
+=========================================
+
+Submodules
+----------
+
+intelligence\_layer.use\_cases.qa.long\_context\_qa module
+----------------------------------------------------------
+
+.. automodule:: intelligence_layer.use_cases.qa.long_context_qa
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+intelligence\_layer.use\_cases.qa.multiple\_chunk\_qa module
+------------------------------------------------------------
+
+.. automodule:: intelligence_layer.use_cases.qa.multiple_chunk_qa
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+intelligence\_layer.use\_cases.qa.retriever\_based\_qa module
+-------------------------------------------------------------
+
+.. automodule:: intelligence_layer.use_cases.qa.retriever_based_qa
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+intelligence\_layer.use\_cases.qa.single\_chunk\_qa module
+----------------------------------------------------------
+
+.. automodule:: intelligence_layer.use_cases.qa.single_chunk_qa
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: intelligence_layer.use_cases.qa
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/intelligence_layer.use_cases.rst

@@ -0,0 +1,21 @@
+intelligence\_layer.use\_cases package
+======================================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   intelligence_layer.use_cases.classify
+   intelligence_layer.use_cases.qa
+   intelligence_layer.use_cases.search
+   intelligence_layer.use_cases.summarize
+
+Module contents
+---------------
+
+.. automodule:: intelligence_layer.use_cases
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/intelligence_layer.use_cases.search.rst

@@ -0,0 +1,21 @@
+intelligence\_layer.use\_cases.search package
+=============================================
+
+Submodules
+----------
+
+intelligence\_layer.use\_cases.search.search module
+---------------------------------------------------
+
+.. automodule:: intelligence_layer.use_cases.search.search
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: intelligence_layer.use_cases.search
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/intelligence_layer.use_cases.summarize.rst

@@ -0,0 +1,21 @@
+intelligence\_layer.use\_cases.summarize package
+================================================
+
+Submodules
+----------
+
+intelligence\_layer.use\_cases.summarize.summarize module
+---------------------------------------------------------
+
+.. automodule:: intelligence_layer.use_cases.summarize.summarize
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: intelligence_layer.use_cases.summarize
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd