Incorporate review suggestions

Author: cyab05

.github/workflows/ci.yaml

@@ -18,8 +18,8 @@ env:
       - "dependabot/**"
       - "gh-readonly-queue/**"
       - "renovate/**"
-      # - "tickets/**"
-      # - "u/**"
+      - "tickets/**"
+      - "u/**"
   release:
     types: [published]
 

python/rubin/__init__.py

@@ -1,4 +1,23 @@
-"""pkgutil-style namespace package."""
+# This file is part of rubin_rag.
+#
+# Developed for the LSST Data Management System.
+# This product includes software developed by the LSST Project
+# (https://www.lsst.org).
+# See the COPYRIGHT file at the top-level directory of this distribution
+# for details of code ownership.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 import pkgutil
 

python/rubin/rag/__init__.py

@@ -1,4 +1,26 @@
-"""Rubin RAG-basd LLM Application."""
+#
+# This file is part of rubin_rag.
+#
+# Developed for the LSST Data Management System.
+# This product includes software developed by the LSST Project
+# (https://www.lsst.org).
+# See the COPYRIGHT file at the top-level directory of this distribution
+# for details of code ownership.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+"""Define and retrieve the version string for the package."""
 
 from importlib.metadata import PackageNotFoundError, version
 

python/rubin/rag/app.py

@@ -1,5 +1,28 @@
-"""Sets up and manages the interactive chatbot interface for the bot,
-using Streamlit.
+#
+# This file is part of rubin_rag.
+#
+# Developed for the LSST Data Management System.
+# This product includes software developed by the LSST Project
+# (https://www.lsst.org).
+# See the COPYRIGHT file at the top-level directory of this distribution
+# for details of code ownership.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+"""Set up the Streamlit interface for the chatbot, configuring the
+retriever, QA chain, session state, UI elements, and handling user of
+interactions.
 """
 
 from pathlib import Path

python/rubin/rag/chatbot.py

@@ -1,14 +1,27 @@
-"""Integrates using Weaviate, LangChain, and OpenAI's GPT-4 to
-facilitate an interactive chatbot.
-
-It includes functions for:
-- Setting up the Weaviate retriever and configuring the environment.
-- Creating a question-answering (QA) chain to process user input using a
-conversational model.
-- Handling user input, managing message history, and filtering responses
-based on specific sources.
-- Interacting with the Streamlit interface to display the chatbot's responses
-and source information.
+#
+# This file is part of rubin_rag.
+#
+# Developed for the LSST Data Management System.
+# This product includes software developed by the LSST Project
+# (https://www.lsst.org).
+# See the COPYRIGHT file at the top-level directory of this distribution
+# for details of code ownership.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+"""Set up a Streamlit-based chatbot using Weaviate for vector search and
+GPT-4o-mini for answering user queries.
 """
 
 import os

python/rubin/rag/custom_weaviate_vector_store.py

@@ -1,4 +1,28 @@
-"""Overrides the similarity search function in WeaviateVectorStore."""
+#
+# This file is part of rubin_rag.
+#
+# Developed for the LSST Data Management System.
+# This product includes software developed by the LSST Project
+# (https://www.lsst.org).
+# See the COPYRIGHT file at the top-level directory of this distribution
+# for details of code ownership.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+"""Override the similarity search function in WeaviateVectorStore and
+return documents with their corresponding similarity scores.
+"""
 
 from collections.abc import Callable
 from typing import Any

python/rubin/rag/extra_scripts/__init__.py

@@ -0,0 +1,20 @@
+# This file is part of rubin_rag.
+#
+# Developed for the LSST Data Management System.
+# This product includes software developed by the LSST Project
+# (https://www.lsst.org).
+# See the COPYRIGHT file at the top-level directory of this distribution
+# for details of code ownership.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.

python/rubin/rag/extra_scripts/parse_confluence.py

@@ -1,5 +1,27 @@
-"""Loads documents from Confluence, processes them, and uploads
-them to Weaviate.
+#
+# This file is part of rubin_rag.
+#
+# Developed for the LSST Data Management System.
+# This product includes software developed by the LSST Project
+# (https://www.lsst.org).
+# See the COPYRIGHT file at the top-level directory of this distribution
+# for details of code ownership.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+"""Load Confluence documents, process metadata, and upload them to Weaviate
+with optional chunking.
 """
 
 from langchain.document_loaders import ConfluenceLoader

python/rubin/rag/extra_scripts/parse_jira_tickets.py

@@ -1,4 +1,28 @@
-"""Loads information from Jira tickets and uploads them to Weaviate."""
+#
+# This file is part of rubin_rag.
+#
+# Developed for the LSST Data Management System.
+# This product includes software developed by the LSST Project
+# (https://www.lsst.org).
+# See the COPYRIGHT file at the top-level directory of this distribution
+# for details of code ownership.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+"""Fetch and process JIRA ticket data, extract relevant details, and
+save results in a structured JSON format.
+"""
 
 import json
 import time

python/rubin/rag/extra_scripts/universal_weaviate_uploader.py

@@ -1,5 +1,27 @@
-"""Uploads documents to Weaviate after optionally splitting them
-into smaller chunks and generating embeddings using OpenAI's API.
+#
+# This file is part of rubin_rag.
+#
+# Developed for the LSST Data Management System.
+# This product includes software developed by the LSST Project
+# (https://www.lsst.org).
+# See the COPYRIGHT file at the top-level directory of this distribution
+# for details of code ownership.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+"""Upload documents to Weaviate using OpenAI embeddings, optionally
+splitting them into smaller chunks before storage.
 """
 
 import os