From 5cfe2c89ae53e46a4302f9f7820798bc541925c9 Mon Sep 17 00:00:00 2001 From: Baptiste Pasquier Date: Mon, 15 Apr 2024 17:54:49 +0200 Subject: [PATCH] :pencil2: update URLs --- .skaff/skaff.yaml | 2 +- README.md | 6 +++--- backend/main.py | 4 ++-- docs/index.md | 4 ++-- frontend/front.py | 3 +-- pyproject.toml | 4 ++-- 6 files changed, 11 insertions(+), 12 deletions(-) diff --git a/.skaff/skaff.yaml b/.skaff/skaff.yaml index d072ce7..c82ccac 100644 --- a/.skaff/skaff.yaml +++ b/.skaff/skaff.yaml @@ -7,7 +7,7 @@ name: GenAI RAG indus kit owner: alexis.vialaret@artefact.com description: > Deploy production grade RAGs quickly, on any cloud. -documentation_url: https://artefactory.github.io/skaff-rag-accelerator/ +documentation_url: https://artefactory-skaff.github.io/skaff-rag-accelerator/ type: deployable # deployable, knowldege pack lifecycle: prototype # prototype, production diff --git a/README.md b/README.md index 5f1c60b..df6c34a 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ This is a starter kit to deploy a modularizable RAG locally or on the cloud (or ## Features -- A configurable RAG setup based around Langchain ([Check out the configuration cookbook here](https://artefactory.github.io/skaff-rag-accelerator/cookbook/)) +- A configurable RAG setup based around Langchain ([Check out the configuration cookbook here](https://artefactory-skaff.github.io/skaff-rag-accelerator/cookbook/)) - `RAG` and `RagConfig` python classes that manage components (vector store, llm, retreiver, ...) - A REST API based on Langserve + FastAPI to provide easy access to the RAG as a web backend - Optional API plugins for secure user authentication, session management, ... @@ -17,7 +17,7 @@ This is a starter kit to deploy a modularizable RAG locally or on the cloud (or ## Quickstart -This quickstart will guide you through the steps to serve the RAG and load a few documents. +This quickstart will guide you through the steps to serve the RAG and load a few documents. You will run both the back and front on your machine. @@ -80,7 +80,7 @@ Right now the RAG does not have any documents loaded, you can use the notebook i To deep dive into under the hood, take a look at the documentation -[On github pages](https://artefactory.github.io/skaff-rag-accelerator/) +[On github pages](https://artefactory-skaff.github.io/skaff-rag-accelerator/) Or serve them locally: ```shell diff --git a/backend/main.py b/backend/main.py index 1595601..08e717f 100644 --- a/backend/main.py +++ b/backend/main.py @@ -7,13 +7,13 @@ from backend.rag_components.rag import RAG # Initialize a RAG as discribed in the config.yaml file -# https://artefactory.github.io/skaff-rag-accelerator/backend/rag_ragconfig/ +# https://artefactory-skaff.github.io/skaff-rag-accelerator/backend/rag_ragconfig/ rag = RAG(config=Path(__file__).parent / "config.yaml") chain = rag.get_chain() # Create a minimal RAG server based on langserve # Learn how to extend this configuration to add authentication and session management -# https://artefactory.github.io/skaff-rag-accelerator/backend/plugins/plugins/ +# https://artefactory-skaff.github.io/skaff-rag-accelerator/backend/plugins/plugins/ app = FastAPI( title="RAG Accelerator", description="A RAG-based question answering API", diff --git a/docs/index.md b/docs/index.md index 9d6967b..fa341f1 100644 --- a/docs/index.md +++ b/docs/index.md @@ -17,7 +17,7 @@ This is a starter kit to deploy a modularizable RAG locally or on the cloud (or ## Quickstart -This quickstart will guide you through the steps to serve the RAG and load a few documents. +This quickstart will guide you through the steps to serve the RAG and load a few documents. You will run both the back and front on your machine. @@ -79,7 +79,7 @@ Right now the RAG does not have any documents loaded, you can use the notebook i To deep dive into under the hood, take a look at the documentation -[On github pages](https://artefactory.github.io/skaff-rag-accelerator/) +[On github pages](https://artefactory-skaff.github.io/skaff-rag-accelerator/) Or serve them locally: ```shell diff --git a/frontend/front.py b/frontend/front.py index cea1b6f..1815604 100644 --- a/frontend/front.py +++ b/frontend/front.py @@ -23,7 +23,7 @@ def browser_tab_title(): def application_header(): st.image(Image.open(ASSETS_PATH / "logo_title.jpeg")) - st.caption("Learn more about the RAG indus kit here: https://artefactory.github.io/skaff-rag-accelerator") + st.caption("Learn more about the RAG indus kit here: https://artefactory-skaff.github.io/skaff-rag-accelerator/") if __name__ == "__main__": @@ -50,7 +50,6 @@ def application_header(): # Once we have an authenticated session, show the chat interface if st.session_state.get("authenticated_session") is not None: - # If the backend supports sessions, enable session navigation if backend_supports_sessions(): initialize_state_variable("email", value="demo.user@email.com") # With authentication, this will take the user's email diff --git a/pyproject.toml b/pyproject.toml index f9644a8..a94e2fa 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -13,8 +13,8 @@ readme = "README.md" requires-python = ">=3.8" [project.urls] -"Homepage" = "https://github.com/artefactory-fr/rag-as-a-service" -"Documentation" = "https://artefactory-fr.github.io/rag-as-a-service" +"Homepage" = "https://github.com/artefactory-skaff/skaff-rag-accelerator" +"Documentation" = "https://artefactory-skaff.github.io/skaff-rag-accelerator/" [tool.setuptools] packages = ["lib", "config", "tests"]