diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle index 8b25d64..5c0af6e 100644 Binary files a/docs/build/doctrees/environment.pickle and b/docs/build/doctrees/environment.pickle differ diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree index 476123c..42edf18 100644 Binary files a/docs/build/doctrees/index.doctree and b/docs/build/doctrees/index.doctree differ diff --git a/docs/build/doctrees/ragoon.doctree b/docs/build/doctrees/ragoon.doctree index 39c601a..36958c5 100644 Binary files a/docs/build/doctrees/ragoon.doctree and b/docs/build/doctrees/ragoon.doctree differ diff --git a/docs/build/html/_sources/index.rst.txt b/docs/build/html/_sources/index.rst.txt index 398fb63..de44599 100644 --- a/docs/build/html/_sources/index.rst.txt +++ b/docs/build/html/_sources/index.rst.txt @@ -13,6 +13,7 @@ Contents: :caption: Modules: modules + api_reference ragoon Indices and tables diff --git a/docs/build/html/_sources/ragoon.rst.txt b/docs/build/html/_sources/ragoon.rst.txt index d51885a..9a61ef8 100644 --- a/docs/build/html/_sources/ragoon.rst.txt +++ b/docs/build/html/_sources/ragoon.rst.txt @@ -1,6 +1,11 @@ ragoon package ============== +.. automodule:: ragoon + :members: + :undoc-members: + :show-inheritance: + Submodules ---------- diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html index ff495c1..2d714b0 100644 --- a/docs/build/html/genindex.html +++ b/docs/build/html/genindex.html @@ -464,7 +464,7 @@

M

module diff --git a/docs/build/html/modules.html b/docs/build/html/modules.html index 0795b25..a7784ae 100644 --- a/docs/build/html/modules.html +++ b/docs/build/html/modules.html @@ -446,7 +446,7 @@

ragoon# -
  • Module contents
  • +
  • Module contents
  • diff --git a/docs/build/html/objects.inv b/docs/build/html/objects.inv index 318ae79..2cb2352 100644 Binary files a/docs/build/html/objects.inv and b/docs/build/html/objects.inv differ diff --git a/docs/build/html/py-modindex.html b/docs/build/html/py-modindex.html index b50bcdd..314d9f9 100644 --- a/docs/build/html/py-modindex.html +++ b/docs/build/html/py-modindex.html @@ -332,7 +332,7 @@

    Python Module Index

    - ragoon + ragoon diff --git a/docs/build/html/ragoon.html b/docs/build/html/ragoon.html index 7c37f79..0c23f6f 100644 --- a/docs/build/html/ragoon.html +++ b/docs/build/html/ragoon.html @@ -356,8 +356,8 @@
    -
    -

    ragoon package#

    +
    +

    ragoon package#

    Submodules#

    @@ -1288,8 +1288,8 @@

    Submodules -

    Module contents#

    +
    +

    Module contents#

    @@ -1414,7 +1414,7 @@

    SubmodulesModule contents +
  • Module contents
  • diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js index 1ccef32..ae3eaba 100644 --- a/docs/build/html/searchindex.js +++ b/docs/build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"Indices and tables": [[0, "indices-and-tables"]], "Module contents": [[2, "module-ragoon"]], "Modules:": [[0, null]], "RAGoon documentation": [[0, null]], "Submodules": [[0, "submodules"], [2, "submodules"]], "ragoon": [[1, null]], "ragoon package": [[0, "module-ragoon"], [2, null]], "ragoon.embeddings module": [[2, "module-ragoon.embeddings"]], "ragoon.similarity_search module": [[2, "module-ragoon.similarity_search"]], "ragoon.web_rag module": [[2, "module-ragoon.web_rag"]]}, "docnames": ["index", "modules", "ragoon"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1}, "filenames": ["index.rst", "modules.rst", "ragoon.rst"], "indexentries": {"batch_size (ragoon.embeddings.embeddingsdataloader attribute)": [[2, "ragoon.embeddings.EmbeddingsDataLoader.batch_size", false]], "convert_to_tensor (ragoon.embeddings.embeddingsdataloader attribute)": [[2, "ragoon.embeddings.EmbeddingsDataLoader.convert_to_tensor", false]], "create_faiss_index() (ragoon.similarity_search.similaritysearch method)": [[2, "id12", false], [2, "ragoon.similarity_search.SimilaritySearch.create_faiss_index", false]], "create_plot() (ragoon.embeddings.embeddingsvisualizer method)": [[2, "ragoon.embeddings.EmbeddingsVisualizer.create_plot", false]], "create_usearch_index() (ragoon.similarity_search.similaritysearch method)": [[2, "id13", false], [2, "ragoon.similarity_search.SimilaritySearch.create_usearch_index", false]], "cuda_available (ragoon.embeddings.embeddingsdataloader attribute)": [[2, "ragoon.embeddings.EmbeddingsDataLoader.cuda_available", false]], "dataset (ragoon.embeddings.embeddingsdataloader attribute)": [[2, "ragoon.embeddings.EmbeddingsDataLoader.dataset", false]], "dataset (ragoon.embeddings.embeddingsvisualizer attribute)": [[2, "ragoon.embeddings.EmbeddingsVisualizer.dataset", false]], "dataset_name (ragoon.embeddings.embeddingsdataloader attribute)": [[2, "ragoon.embeddings.EmbeddingsDataLoader.dataset_name", false]], "dataset_path (ragoon.embeddings.embeddingsvisualizer attribute)": [[2, "ragoon.embeddings.EmbeddingsVisualizer.dataset_path", false]], "device (ragoon.similarity_search.similaritysearch attribute)": [[2, "ragoon.similarity_search.SimilaritySearch.device", false]], "dtype (ragoon.similarity_search.similaritysearch attribute)": [[2, "ragoon.similarity_search.SimilaritySearch.dtype", false]], "embed() (ragoon.embeddings.embeddingsdataloader method)": [[2, "id0", false], [2, "ragoon.embeddings.EmbeddingsDataLoader.embed", false]], "embeddingsdataloader (class in ragoon.embeddings)": [[2, "ragoon.embeddings.EmbeddingsDataLoader", false]], "embeddingsvisualizer (class in ragoon.embeddings)": [[2, "ragoon.embeddings.EmbeddingsVisualizer", false]], "encode() (ragoon.embeddings.embeddingsdataloader method)": [[2, "id1", false], [2, "ragoon.embeddings.EmbeddingsDataLoader.encode", false]], "encode() (ragoon.similarity_search.similaritysearch method)": [[2, "id14", false], [2, "ragoon.similarity_search.SimilaritySearch.encode", false]], "extract_vectors() (ragoon.embeddings.embeddingsvisualizer method)": [[2, "id9", false], [2, "ragoon.embeddings.EmbeddingsVisualizer.extract_vectors", false]], "get_dataset() (ragoon.embeddings.embeddingsdataloader method)": [[2, "id2", false], [2, "ragoon.embeddings.EmbeddingsDataLoader.get_dataset", false]], "index (ragoon.embeddings.embeddingsvisualizer attribute)": [[2, "ragoon.embeddings.EmbeddingsVisualizer.index", false]], "index_path (ragoon.embeddings.embeddingsvisualizer attribute)": [[2, "ragoon.embeddings.EmbeddingsVisualizer.index_path", false]], "labels (ragoon.embeddings.embeddingsvisualizer attribute)": [[2, "ragoon.embeddings.EmbeddingsVisualizer.labels", false]], "load_dataset() (ragoon.embeddings.embeddingsdataloader method)": [[2, "id3", false], [2, "ragoon.embeddings.EmbeddingsDataLoader.load_dataset", false]], "load_dataset() (ragoon.embeddings.embeddingsvisualizer method)": [[2, "id10", false], [2, "ragoon.embeddings.EmbeddingsVisualizer.load_dataset", false]], "load_faiss_index() (ragoon.similarity_search.similaritysearch method)": [[2, "id15", false], [2, "ragoon.similarity_search.SimilaritySearch.load_faiss_index", false]], "load_index() (ragoon.embeddings.embeddingsvisualizer method)": [[2, "id11", false], [2, "ragoon.embeddings.EmbeddingsVisualizer.load_index", false]], "load_model() (ragoon.embeddings.embeddingsdataloader method)": [[2, "id4", false], [2, "ragoon.embeddings.EmbeddingsDataLoader.load_model", false]], "load_usearch_index_view() (ragoon.similarity_search.similaritysearch method)": [[2, "id16", false], [2, "ragoon.similarity_search.SimilaritySearch.load_usearch_index_view", false]], "metric (ragoon.similarity_search.similaritysearch attribute)": [[2, "ragoon.similarity_search.SimilaritySearch.metric", false]], "model_configs (ragoon.embeddings.embeddingsdataloader attribute)": [[2, "ragoon.embeddings.EmbeddingsDataLoader.model_configs", false]], "model_name (ragoon.similarity_search.similaritysearch attribute)": [[2, "ragoon.similarity_search.SimilaritySearch.model_name", false]], "module": [[0, "module-ragoon", false], [2, "module-ragoon", false], [2, "module-ragoon.embeddings", false], [2, "module-ragoon.similarity_search", false], [2, "module-ragoon.web_rag", false]], "ndim (ragoon.similarity_search.similaritysearch attribute)": [[2, "ragoon.similarity_search.SimilaritySearch.ndim", false]], "plot_3d() (ragoon.embeddings.embeddingsvisualizer method)": [[2, "ragoon.embeddings.EmbeddingsVisualizer.plot_3d", false]], "process_split() (ragoon.embeddings.embeddingsdataloader method)": [[2, "id5", false], [2, "ragoon.embeddings.EmbeddingsDataLoader.process_split", false]], "process_splits() (ragoon.embeddings.embeddingsdataloader method)": [[2, "id6", false], [2, "ragoon.embeddings.EmbeddingsDataLoader.process_splits", false]], "quantize_embeddings() (ragoon.similarity_search.similaritysearch method)": [[2, "id17", false], [2, "ragoon.similarity_search.SimilaritySearch.quantize_embeddings", false]], "ragoon": [[0, "module-ragoon", false], [2, "module-ragoon", false]], "ragoon.embeddings": [[2, "module-ragoon.embeddings", false]], "ragoon.similarity_search": [[2, "module-ragoon.similarity_search", false]], "ragoon.web_rag": [[2, "module-ragoon.web_rag", false]], "reduce_dimensionality() (ragoon.embeddings.embeddingsvisualizer method)": [[2, "ragoon.embeddings.EmbeddingsVisualizer.reduce_dimensionality", false]], "reduced_vectors (ragoon.embeddings.embeddingsvisualizer attribute)": [[2, "ragoon.embeddings.EmbeddingsVisualizer.reduced_vectors", false]], "save_dataset() (ragoon.embeddings.embeddingsdataloader method)": [[2, "id7", false], [2, "ragoon.embeddings.EmbeddingsDataLoader.save_dataset", false]], "search() (ragoon.similarity_search.similaritysearch method)": [[2, "id18", false], [2, "ragoon.similarity_search.SimilaritySearch.search", false]], "search() (ragoon.web_rag.webrag method)": [[2, "ragoon.web_rag.WebRAG.search", false]], "similaritysearch (class in ragoon.similarity_search)": [[2, "ragoon.similarity_search.SimilaritySearch", false]], "token (ragoon.embeddings.embeddingsdataloader attribute)": [[2, "ragoon.embeddings.EmbeddingsDataLoader.token", false]], "upload_dataset() (ragoon.embeddings.embeddingsdataloader method)": [[2, "id8", false], [2, "ragoon.embeddings.EmbeddingsDataLoader.upload_dataset", false]], "vectors (ragoon.embeddings.embeddingsvisualizer attribute)": [[2, "ragoon.embeddings.EmbeddingsVisualizer.vectors", false]], "visualize() (ragoon.embeddings.embeddingsvisualizer method)": [[2, "ragoon.embeddings.EmbeddingsVisualizer.visualize", false]], "webrag (class in ragoon.web_rag)": [[2, "ragoon.web_rag.WebRAG", false]]}, "objects": {"": [[0, 0, 0, "-", "ragoon"]], "ragoon": [[2, 0, 0, "-", "embeddings"], [2, 0, 0, "-", "similarity_search"], [2, 0, 0, "-", "web_rag"]], "ragoon.embeddings": [[2, 1, 1, "", "EmbeddingsDataLoader"], [2, 1, 1, "", "EmbeddingsVisualizer"]], "ragoon.embeddings.EmbeddingsDataLoader": [[2, 2, 1, "", "batch_size"], [2, 2, 1, "", "convert_to_tensor"], [2, 2, 1, "", "cuda_available"], [2, 2, 1, "", "dataset"], [2, 2, 1, "", "dataset_name"], [2, 3, 1, "id0", "embed"], [2, 3, 1, "id1", "encode"], [2, 3, 1, "id2", "get_dataset"], [2, 3, 1, "id3", "load_dataset"], [2, 3, 1, "id4", "load_model"], [2, 2, 1, "", "model_configs"], [2, 3, 1, "id5", "process_split"], [2, 3, 1, "id6", "process_splits"], [2, 3, 1, "id7", "save_dataset"], [2, 2, 1, "", "token"], [2, 3, 1, "id8", "upload_dataset"]], "ragoon.embeddings.EmbeddingsVisualizer": [[2, 3, 1, "", "create_plot"], [2, 2, 1, "", "dataset"], [2, 2, 1, "", "dataset_path"], [2, 3, 1, "id9", "extract_vectors"], [2, 2, 1, "", "index"], [2, 2, 1, "", "index_path"], [2, 2, 1, "", "labels"], [2, 3, 1, "id10", "load_dataset"], [2, 3, 1, "id11", "load_index"], [2, 3, 1, "", "plot_3d"], [2, 3, 1, "", "reduce_dimensionality"], [2, 2, 1, "", "reduced_vectors"], [2, 2, 1, "", "vectors"], [2, 3, 1, "", "visualize"]], "ragoon.similarity_search": [[2, 1, 1, "", "SimilaritySearch"]], "ragoon.similarity_search.SimilaritySearch": [[2, 3, 1, "id12", "create_faiss_index"], [2, 3, 1, "id13", "create_usearch_index"], [2, 2, 1, "", "device"], [2, 2, 1, "", "dtype"], [2, 3, 1, "id14", "encode"], [2, 3, 1, "id15", "load_faiss_index"], [2, 3, 1, "id16", "load_usearch_index_view"], [2, 2, 1, "", "metric"], [2, 2, 1, "", "model_name"], [2, 2, 1, "", "ndim"], [2, 3, 1, "id17", "quantize_embeddings"], [2, 3, 1, "id18", "search"]], "ragoon.web_rag": [[2, 1, 1, "", "WebRAG"]], "ragoon.web_rag.WebRAG": [[2, 3, 1, "", "search"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "method", "Python method"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:method"}, "terms": {"": 2, "0": 2, "1": 2, "10": 2, "102": 2, "1024": 2, "16": 2, "3": 2, "36": 2, "3d": 2, "4": 2, "42": 2, "4758": 2, "5": 2, "50": 2, "537": 2, "768": 2, "8": 2, "98": 2, "A": 2, "If": 2, "In": 2, "It": 2, "The": 2, "Then": 2, "acceler": 2, "access": 2, "add": 2, "addit": 2, "address": 2, "after": 2, "against": 2, "all": 2, "allow": 2, "alreadi": 2, "an": 2, "analysi": 2, "ani": 2, "api": 2, "applewebkit": 2, "appli": 2, "approach": 2, "approxim": 2, "ar": 2, "arg": 2, "argument": 2, "articl": 2, "assimil": 2, "assum": 2, "attribut": 2, "au": 2, "avail": 2, "ayant": 2, "bar": 2, "base": 2, "batch": 2, "batch_siz": [1, 2], "been": 2, "being": 2, "binari": 2, "binary_index": 2, "bit": 2, "bool": 2, "both": 2, "bytearrai": 2, "call": 2, "can": 2, "captur": 2, "case": 2, "chain": 2, "chrome": 2, "class": 2, "column": 2, "combin": 2, "comm": 2, "commonli": 2, "compat": 2, "complet": 2, "completion_cli": 2, "completion_data": 2, "completion_model": 2, "compon": 2, "comput": 2, "concis": 2, "configur": 2, "consid\u00e9r\u00e9": 2, "construct": 2, "contain": 2, "content": [0, 1], "context": 2, "contextu": 2, "contribut": 2, "convers": 2, "convert_to_tensor": [1, 2], "corpu": 2, "correspond": 2, "cosin": 2, "cost": 2, "cpu": 2, "creat": 2, "create_faiss_index": [1, 2], "create_plot": [1, 2], "create_usearch_index": [1, 2], "cuda": 2, "cuda_avail": [1, 2], "data": 2, "dataset": [1, 2], "dataset_nam": [1, 2], "dataset_path": [1, 2], "datasetdict": 2, "de": 2, "dedic": 2, "default": 2, "depend": 2, "detail": [], "devic": [1, 2], "dialogu": 2, "dict": 2, "dictionari": 2, "dimens": 2, "dimension": 2, "direct": 2, "directli": 2, "directori": 2, "disk": 2, "document": 2, "domicil": 2, "dot": 2, "dot_scor": 2, "dtype": [1, 2], "dure": 2, "dynam": 2, "e": 2, "each": 2, "effect": 2, "effici": 2, "either": 2, "emb": [1, 2], "embed": [0, 1], "embedding_visu": 2, "embeddingsdataload": [1, 2], "embeddingsvisu": [1, 2], "en": 2, "encod": [1, 2], "enhanc": 2, "ensur": 2, "etc": 2, "exampl": 2, "except": 2, "explor": 2, "extract": 2, "extract_vector": [1, 2], "face": 2, "facilit": 2, "fail": 2, "faiss": 2, "faiss_ubinari": 2, "fals": 2, "faster": 2, "fetch": 2, "few": 2, "figur": 2, "file": 2, "final": 2, "final_compon": 2, "first": 2, "fiscal": 2, "float": 2, "follow": 2, "form": 2, "format": 2, "franc": 2, "from": 2, "full": 2, "function": 2, "further": 2, "g": 2, "gecko": 2, "gener": 2, "get_dataset": [1, 2], "given": 2, "global": 2, "go": 2, "googl": 2, "google_api_kei": 2, "google_cx": 2, "gpu": 2, "ha": 2, "handl": 2, "have": 2, "help": 2, "high": 2, "higher": 2, "html": 2, "html_file_nam": 2, "hub": 2, "hug": 2, "i": 2, "i8": 2, "id": 2, "identifi": 2, "implement": 2, "increas": 2, "index": [0, 1, 2], "index_path": [1, 2], "indic": 2, "inferencecli": 2, "inform": 2, "initi": 2, "inner": 2, "input": 2, "instal": 2, "instanc": 2, "instead": 2, "int": 2, "int8": 2, "int8_embed": 2, "int8_index": 2, "integ": 2, "intent": 2, "interact": 2, "invalid": 2, "ip": 2, "issu": 2, "itself": 2, "json": 2, "k": 2, "karg": 2, "keep": 2, "kei": 2, "keyword": 2, "khtml": 2, "kwarg": 2, "l": 2, "lab": 2, "label": [1, 2], "larg": 2, "learn": 2, "lemon": 2, "length": 2, "leur": 2, "librari": 2, "like": 2, "linear": 2, "list": 2, "llm": 2, "load": 2, "load_dataset": [1, 2], "load_faiss_index": [1, 2], "load_index": [1, 2], "load_model": [1, 2], "load_usearch_index_view": [1, 2], "local": 2, "louisbrulenaudet": 2, "low": 2, "lower": 2, "main": 2, "manag": 2, "manifold": 2, "marker": 2, "mbert": 2, "memori": 2, "method": 2, "metric": [1, 2], "model": 2, "model_config": [1, 2], "model_nam": [1, 2], "modul": 1, "more": 2, "most": 2, "mozilla": 2, "multipli": 2, "must": 2, "my": 2, "n": 2, "name": 2, "ndarrai": 2, "ndim": [1, 2], "non": 2, "none": 2, "normal": 2, "normalize_embed": 2, "note": 2, "np": 2, "nt": 2, "nuanc": 2, "number": 2, "numpi": 2, "object": 2, "one": 2, "onto": 2, "oper": 2, "option": 2, "output": 2, "output_dir": 2, "packag": 1, "page": 0, "paramet": 2, "particularli": 2, "pass": 2, "passag": 2, "passage_prefix": 2, "path": 2, "pca": 2, "pca_compon": 2, "pca_umap": 2, "perform": 2, "pipelin": 2, "pleas": 2, "plot": 2, "plot_3d": [1, 2], "plotli": 2, "point": 2, "point_siz": 2, "posit": 2, "precis": 2, "prefix": 2, "preserv": 2, "princip": 2, "process": 2, "process_split": [1, 2], "product": 2, "progress": 2, "project": 2, "provid": 2, "quantiz": 2, "quantization_typ": 2, "quantize_embed": [1, 2], "queri": 2, "query_prefix": 2, "question": 2, "rais": 2, "random": 2, "random_st": 2, "re": 2, "readi": 2, "reduc": 2, "reduce_dimension": [1, 2], "reduced_vector": [1, 2], "reduct": 2, "relat": 2, "relev": 2, "repo_id": 2, "repositori": 2, "represent": 2, "reproduc": 2, "requir": 2, "rescore_multipli": 2, "respons": 2, "restructuredtext": [], "result": 2, "retriev": 2, "return": 2, "rich": 2, "runtimeerror": 2, "safari": 2, "sampl": 2, "save": 2, "save_dataset": [1, 2], "save_html": 2, "scatter": 2, "score": 2, "search": [0, 1, 2], "search_queri": 2, "see": [], "self": 2, "sen": 2, "sentenc": 2, "sentencetransform": 2, "shot": 2, "should": 2, "show": 2, "significantli": 2, "similar": 2, "similarity_search": [0, 1], "similaritysearch": [1, 2], "size": 2, "sne": 2, "sont": 2, "sourc": 2, "space": 2, "specif": 2, "specifi": 2, "split": 2, "state": 2, "step": 2, "storag": 2, "store": 2, "str": 2, "string": 2, "structur": 2, "submodul": 1, "subsequ": 2, "suit": 2, "syntax": [], "system_prompt": 2, "t": 2, "tailor": 2, "techniqu": 2, "tensor": 2, "text": 2, "them": 2, "thi": 2, "titl": 2, "token": [1, 2], "top": 2, "top_k": 2, "top_k_indic": 2, "top_k_scor": 2, "track": 2, "true": 2, "tsdae": 2, "tsne": 2, "tupl": 2, "two": 2, "type": 2, "ubinari": 2, "ubinary_embed": 2, "umap": 2, "underli": 2, "uniform": 2, "union": 2, "unsign": 2, "unsupport": 2, "upload": 2, "upload_dataset": [1, 2], "us": 2, "usearch": 2, "usearch_int8": 2, "user": 2, "user_ag": 2, "util": 2, "valu": 2, "valueerror": 2, "vari": 2, "vector": [1, 2], "view": 2, "visual": [1, 2], "web_rag": [0, 1], "webrag": [1, 2], "well": 2, "when": 2, "where": 2, "whether": 2, "which": 2, "win64": 2, "window": 2, "would": 2, "x64": 2, "yet": 2, "your": []}, "titles": ["RAGoon documentation", "ragoon", "ragoon package"], "titleterms": {"content": 2, "document": 0, "embed": 2, "indic": 0, "modul": [0, 2], "packag": [0, 2], "ragoon": [0, 1, 2], "similarity_search": 2, "submodul": [0, 2], "tabl": 0, "web_rag": 2}}) \ No newline at end of file +Search.setIndex({"alltitles": {"Indices and tables": [[0, "indices-and-tables"]], "Module contents": [[2, "module-0"]], "Modules:": [[0, null]], "RAGoon documentation": [[0, null]], "Submodules": [[0, "submodules"], [2, "submodules"]], "ragoon": [[1, null]], "ragoon package": [[0, "module-ragoon"], [2, null]], "ragoon.embeddings module": [[2, "module-ragoon.embeddings"]], "ragoon.similarity_search module": [[2, "module-ragoon.similarity_search"]], "ragoon.web_rag module": [[2, "module-ragoon.web_rag"]]}, "docnames": ["index", "modules", "ragoon"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1}, "filenames": ["index.rst", "modules.rst", "ragoon.rst"], "indexentries": {"batch_size (ragoon.embeddings.embeddingsdataloader attribute)": [[2, "ragoon.embeddings.EmbeddingsDataLoader.batch_size", false]], "convert_to_tensor (ragoon.embeddings.embeddingsdataloader attribute)": [[2, "ragoon.embeddings.EmbeddingsDataLoader.convert_to_tensor", false]], "create_faiss_index() (ragoon.similarity_search.similaritysearch method)": [[2, "id12", false], [2, "ragoon.similarity_search.SimilaritySearch.create_faiss_index", false]], "create_plot() (ragoon.embeddings.embeddingsvisualizer method)": [[2, "ragoon.embeddings.EmbeddingsVisualizer.create_plot", false]], "create_usearch_index() (ragoon.similarity_search.similaritysearch method)": [[2, "id13", false], [2, "ragoon.similarity_search.SimilaritySearch.create_usearch_index", false]], "cuda_available (ragoon.embeddings.embeddingsdataloader attribute)": [[2, "ragoon.embeddings.EmbeddingsDataLoader.cuda_available", false]], "dataset (ragoon.embeddings.embeddingsdataloader attribute)": [[2, "ragoon.embeddings.EmbeddingsDataLoader.dataset", false]], "dataset (ragoon.embeddings.embeddingsvisualizer attribute)": [[2, "ragoon.embeddings.EmbeddingsVisualizer.dataset", false]], "dataset_name (ragoon.embeddings.embeddingsdataloader attribute)": [[2, "ragoon.embeddings.EmbeddingsDataLoader.dataset_name", false]], "dataset_path (ragoon.embeddings.embeddingsvisualizer attribute)": [[2, "ragoon.embeddings.EmbeddingsVisualizer.dataset_path", false]], "device (ragoon.similarity_search.similaritysearch attribute)": [[2, "ragoon.similarity_search.SimilaritySearch.device", false]], "dtype (ragoon.similarity_search.similaritysearch attribute)": [[2, "ragoon.similarity_search.SimilaritySearch.dtype", false]], "embed() (ragoon.embeddings.embeddingsdataloader method)": [[2, "id0", false], [2, "ragoon.embeddings.EmbeddingsDataLoader.embed", false]], "embeddingsdataloader (class in ragoon.embeddings)": [[2, "ragoon.embeddings.EmbeddingsDataLoader", false]], "embeddingsvisualizer (class in ragoon.embeddings)": [[2, "ragoon.embeddings.EmbeddingsVisualizer", false]], "encode() (ragoon.embeddings.embeddingsdataloader method)": [[2, "id1", false], [2, "ragoon.embeddings.EmbeddingsDataLoader.encode", false]], "encode() (ragoon.similarity_search.similaritysearch method)": [[2, "id14", false], [2, "ragoon.similarity_search.SimilaritySearch.encode", false]], "extract_vectors() (ragoon.embeddings.embeddingsvisualizer method)": [[2, "id9", false], [2, "ragoon.embeddings.EmbeddingsVisualizer.extract_vectors", false]], "get_dataset() (ragoon.embeddings.embeddingsdataloader method)": [[2, "id2", false], [2, "ragoon.embeddings.EmbeddingsDataLoader.get_dataset", false]], "index (ragoon.embeddings.embeddingsvisualizer attribute)": [[2, "ragoon.embeddings.EmbeddingsVisualizer.index", false]], "index_path (ragoon.embeddings.embeddingsvisualizer attribute)": [[2, "ragoon.embeddings.EmbeddingsVisualizer.index_path", false]], "labels (ragoon.embeddings.embeddingsvisualizer attribute)": [[2, "ragoon.embeddings.EmbeddingsVisualizer.labels", false]], "load_dataset() (ragoon.embeddings.embeddingsdataloader method)": [[2, "id3", false], [2, "ragoon.embeddings.EmbeddingsDataLoader.load_dataset", false]], "load_dataset() (ragoon.embeddings.embeddingsvisualizer method)": [[2, "id10", false], [2, "ragoon.embeddings.EmbeddingsVisualizer.load_dataset", false]], "load_faiss_index() (ragoon.similarity_search.similaritysearch method)": [[2, "id15", false], [2, "ragoon.similarity_search.SimilaritySearch.load_faiss_index", false]], "load_index() (ragoon.embeddings.embeddingsvisualizer method)": [[2, "id11", false], [2, "ragoon.embeddings.EmbeddingsVisualizer.load_index", false]], "load_model() (ragoon.embeddings.embeddingsdataloader method)": [[2, "id4", false], [2, "ragoon.embeddings.EmbeddingsDataLoader.load_model", false]], "load_usearch_index_view() (ragoon.similarity_search.similaritysearch method)": [[2, "id16", false], [2, "ragoon.similarity_search.SimilaritySearch.load_usearch_index_view", false]], "metric (ragoon.similarity_search.similaritysearch attribute)": [[2, "ragoon.similarity_search.SimilaritySearch.metric", false]], "model_configs (ragoon.embeddings.embeddingsdataloader attribute)": [[2, "ragoon.embeddings.EmbeddingsDataLoader.model_configs", false]], "model_name (ragoon.similarity_search.similaritysearch attribute)": [[2, "ragoon.similarity_search.SimilaritySearch.model_name", false]], "module": [[0, "module-ragoon", false], [2, "module-0", false], [2, "module-ragoon", false], [2, "module-ragoon.embeddings", false], [2, "module-ragoon.similarity_search", false], [2, "module-ragoon.web_rag", false]], "ndim (ragoon.similarity_search.similaritysearch attribute)": [[2, "ragoon.similarity_search.SimilaritySearch.ndim", false]], "plot_3d() (ragoon.embeddings.embeddingsvisualizer method)": [[2, "ragoon.embeddings.EmbeddingsVisualizer.plot_3d", false]], "process_split() (ragoon.embeddings.embeddingsdataloader method)": [[2, "id5", false], [2, "ragoon.embeddings.EmbeddingsDataLoader.process_split", false]], "process_splits() (ragoon.embeddings.embeddingsdataloader method)": [[2, "id6", false], [2, "ragoon.embeddings.EmbeddingsDataLoader.process_splits", false]], "quantize_embeddings() (ragoon.similarity_search.similaritysearch method)": [[2, "id17", false], [2, "ragoon.similarity_search.SimilaritySearch.quantize_embeddings", false]], "ragoon": [[0, "module-ragoon", false], [2, "module-0", false], [2, "module-ragoon", false]], "ragoon.embeddings": [[2, "module-ragoon.embeddings", false]], "ragoon.similarity_search": [[2, "module-ragoon.similarity_search", false]], "ragoon.web_rag": [[2, "module-ragoon.web_rag", false]], "reduce_dimensionality() (ragoon.embeddings.embeddingsvisualizer method)": [[2, "ragoon.embeddings.EmbeddingsVisualizer.reduce_dimensionality", false]], "reduced_vectors (ragoon.embeddings.embeddingsvisualizer attribute)": [[2, "ragoon.embeddings.EmbeddingsVisualizer.reduced_vectors", false]], "save_dataset() (ragoon.embeddings.embeddingsdataloader method)": [[2, "id7", false], [2, "ragoon.embeddings.EmbeddingsDataLoader.save_dataset", false]], "search() (ragoon.similarity_search.similaritysearch method)": [[2, "id18", false], [2, "ragoon.similarity_search.SimilaritySearch.search", false]], "search() (ragoon.web_rag.webrag method)": [[2, "ragoon.web_rag.WebRAG.search", false]], "similaritysearch (class in ragoon.similarity_search)": [[2, "ragoon.similarity_search.SimilaritySearch", false]], "token (ragoon.embeddings.embeddingsdataloader attribute)": [[2, "ragoon.embeddings.EmbeddingsDataLoader.token", false]], "upload_dataset() (ragoon.embeddings.embeddingsdataloader method)": [[2, "id8", false], [2, "ragoon.embeddings.EmbeddingsDataLoader.upload_dataset", false]], "vectors (ragoon.embeddings.embeddingsvisualizer attribute)": [[2, "ragoon.embeddings.EmbeddingsVisualizer.vectors", false]], "visualize() (ragoon.embeddings.embeddingsvisualizer method)": [[2, "ragoon.embeddings.EmbeddingsVisualizer.visualize", false]], "webrag (class in ragoon.web_rag)": [[2, "ragoon.web_rag.WebRAG", false]]}, "objects": {"": [[2, 0, 0, "module-0", "ragoon"]], "ragoon": [[2, 0, 0, "-", "embeddings"], [2, 0, 0, "-", "similarity_search"], [2, 0, 0, "-", "web_rag"]], "ragoon.embeddings": [[2, 1, 1, "", "EmbeddingsDataLoader"], [2, 1, 1, "", "EmbeddingsVisualizer"]], "ragoon.embeddings.EmbeddingsDataLoader": [[2, 2, 1, "", "batch_size"], [2, 2, 1, "", "convert_to_tensor"], [2, 2, 1, "", "cuda_available"], [2, 2, 1, "", "dataset"], [2, 2, 1, "", "dataset_name"], [2, 3, 1, "id0", "embed"], [2, 3, 1, "id1", "encode"], [2, 3, 1, "id2", "get_dataset"], [2, 3, 1, "id3", "load_dataset"], [2, 3, 1, "id4", "load_model"], [2, 2, 1, "", "model_configs"], [2, 3, 1, "id5", "process_split"], [2, 3, 1, "id6", "process_splits"], [2, 3, 1, "id7", "save_dataset"], [2, 2, 1, "", "token"], [2, 3, 1, "id8", "upload_dataset"]], "ragoon.embeddings.EmbeddingsVisualizer": [[2, 3, 1, "", "create_plot"], [2, 2, 1, "", "dataset"], [2, 2, 1, "", "dataset_path"], [2, 3, 1, "id9", "extract_vectors"], [2, 2, 1, "", "index"], [2, 2, 1, "", "index_path"], [2, 2, 1, "", "labels"], [2, 3, 1, "id10", "load_dataset"], [2, 3, 1, "id11", "load_index"], [2, 3, 1, "", "plot_3d"], [2, 3, 1, "", "reduce_dimensionality"], [2, 2, 1, "", "reduced_vectors"], [2, 2, 1, "", "vectors"], [2, 3, 1, "", "visualize"]], "ragoon.similarity_search": [[2, 1, 1, "", "SimilaritySearch"]], "ragoon.similarity_search.SimilaritySearch": [[2, 3, 1, "id12", "create_faiss_index"], [2, 3, 1, "id13", "create_usearch_index"], [2, 2, 1, "", "device"], [2, 2, 1, "", "dtype"], [2, 3, 1, "id14", "encode"], [2, 3, 1, "id15", "load_faiss_index"], [2, 3, 1, "id16", "load_usearch_index_view"], [2, 2, 1, "", "metric"], [2, 2, 1, "", "model_name"], [2, 2, 1, "", "ndim"], [2, 3, 1, "id17", "quantize_embeddings"], [2, 3, 1, "id18", "search"]], "ragoon.web_rag": [[2, 1, 1, "", "WebRAG"]], "ragoon.web_rag.WebRAG": [[2, 3, 1, "", "search"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "method", "Python method"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:method"}, "terms": {"": 2, "0": 2, "1": 2, "10": 2, "102": 2, "1024": 2, "16": 2, "3": 2, "36": 2, "3d": 2, "4": 2, "42": 2, "4758": 2, "5": 2, "50": 2, "537": 2, "768": 2, "8": 2, "98": 2, "A": 2, "If": 2, "In": 2, "It": 2, "The": 2, "Then": 2, "acceler": 2, "access": 2, "add": 2, "addit": 2, "address": 2, "after": 2, "against": 2, "all": 2, "allow": 2, "alreadi": 2, "an": 2, "analysi": 2, "ani": 2, "api": 2, "applewebkit": 2, "appli": 2, "approach": 2, "approxim": 2, "ar": 2, "arg": 2, "argument": 2, "articl": 2, "assimil": 2, "assum": 2, "attribut": 2, "au": 2, "avail": 2, "ayant": 2, "bar": 2, "base": 2, "batch": 2, "batch_siz": [1, 2], "been": 2, "being": 2, "binari": 2, "binary_index": 2, "bit": 2, "bool": 2, "both": 2, "bytearrai": 2, "call": 2, "can": 2, "captur": 2, "case": 2, "chain": 2, "chrome": 2, "class": 2, "column": 2, "combin": 2, "comm": 2, "commonli": 2, "compat": 2, "complet": 2, "completion_cli": 2, "completion_data": 2, "completion_model": 2, "compon": 2, "comput": 2, "concis": 2, "configur": 2, "consid\u00e9r\u00e9": 2, "construct": 2, "contain": 2, "content": [0, 1], "context": 2, "contextu": 2, "contribut": 2, "convers": 2, "convert_to_tensor": [1, 2], "corpu": 2, "correspond": 2, "cosin": 2, "cost": 2, "cpu": 2, "creat": 2, "create_faiss_index": [1, 2], "create_plot": [1, 2], "create_usearch_index": [1, 2], "cuda": 2, "cuda_avail": [1, 2], "data": 2, "dataset": [1, 2], "dataset_nam": [1, 2], "dataset_path": [1, 2], "datasetdict": 2, "de": 2, "dedic": 2, "default": 2, "depend": 2, "detail": [], "devic": [1, 2], "dialogu": 2, "dict": 2, "dictionari": 2, "dimens": 2, "dimension": 2, "direct": 2, "directli": 2, "directori": 2, "disk": 2, "document": 2, "domicil": 2, "dot": 2, "dot_scor": 2, "dtype": [1, 2], "dure": 2, "dynam": 2, "e": 2, "each": 2, "effect": 2, "effici": 2, "either": 2, "emb": [1, 2], "embed": [0, 1], "embedding_visu": 2, "embeddingsdataload": [1, 2], "embeddingsvisu": [1, 2], "en": 2, "encod": [1, 2], "enhanc": 2, "ensur": 2, "etc": 2, "exampl": 2, "except": 2, "explor": 2, "extract": 2, "extract_vector": [1, 2], "face": 2, "facilit": 2, "fail": 2, "faiss": 2, "faiss_ubinari": 2, "fals": 2, "faster": 2, "fetch": 2, "few": 2, "figur": 2, "file": 2, "final": 2, "final_compon": 2, "first": 2, "fiscal": 2, "float": 2, "follow": 2, "form": 2, "format": 2, "franc": 2, "from": 2, "full": 2, "function": 2, "further": 2, "g": 2, "gecko": 2, "gener": 2, "get_dataset": [1, 2], "given": 2, "global": 2, "go": 2, "googl": 2, "google_api_kei": 2, "google_cx": 2, "gpu": 2, "ha": 2, "handl": 2, "have": 2, "help": 2, "high": 2, "higher": 2, "html": 2, "html_file_nam": 2, "hub": 2, "hug": 2, "i": 2, "i8": 2, "id": 2, "identifi": 2, "implement": 2, "increas": 2, "index": [0, 1, 2], "index_path": [1, 2], "indic": 2, "inferencecli": 2, "inform": 2, "initi": 2, "inner": 2, "input": 2, "instal": 2, "instanc": 2, "instead": 2, "int": 2, "int8": 2, "int8_embed": 2, "int8_index": 2, "integ": 2, "intent": 2, "interact": 2, "invalid": 2, "ip": 2, "issu": 2, "itself": 2, "json": 2, "k": 2, "karg": 2, "keep": 2, "kei": 2, "keyword": 2, "khtml": 2, "kwarg": 2, "l": 2, "lab": 2, "label": [1, 2], "larg": 2, "learn": 2, "lemon": 2, "length": 2, "leur": 2, "librari": 2, "like": 2, "linear": 2, "list": 2, "llm": 2, "load": 2, "load_dataset": [1, 2], "load_faiss_index": [1, 2], "load_index": [1, 2], "load_model": [1, 2], "load_usearch_index_view": [1, 2], "local": 2, "louisbrulenaudet": 2, "low": 2, "lower": 2, "main": 2, "manag": 2, "manifold": 2, "marker": 2, "mbert": 2, "memori": 2, "method": 2, "metric": [1, 2], "model": 2, "model_config": [1, 2], "model_nam": [1, 2], "modul": 1, "more": 2, "most": 2, "mozilla": 2, "multipli": 2, "must": 2, "my": 2, "n": 2, "name": 2, "ndarrai": 2, "ndim": [1, 2], "non": 2, "none": 2, "normal": 2, "normalize_embed": 2, "note": 2, "np": 2, "nt": 2, "nuanc": 2, "number": 2, "numpi": 2, "object": 2, "one": 2, "onto": 2, "oper": 2, "option": 2, "output": 2, "output_dir": 2, "packag": 1, "page": 0, "paramet": 2, "particularli": 2, "pass": 2, "passag": 2, "passage_prefix": 2, "path": 2, "pca": 2, "pca_compon": 2, "pca_umap": 2, "perform": 2, "pipelin": 2, "pleas": 2, "plot": 2, "plot_3d": [1, 2], "plotli": 2, "point": 2, "point_siz": 2, "posit": 2, "precis": 2, "prefix": 2, "preserv": 2, "princip": 2, "process": 2, "process_split": [1, 2], "product": 2, "progress": 2, "project": 2, "provid": 2, "quantiz": 2, "quantization_typ": 2, "quantize_embed": [1, 2], "queri": 2, "query_prefix": 2, "question": 2, "rais": 2, "random": 2, "random_st": 2, "re": 2, "readi": 2, "reduc": 2, "reduce_dimension": [1, 2], "reduced_vector": [1, 2], "reduct": 2, "relat": 2, "relev": 2, "repo_id": 2, "repositori": 2, "represent": 2, "reproduc": 2, "requir": 2, "rescore_multipli": 2, "respons": 2, "restructuredtext": [], "result": 2, "retriev": 2, "return": 2, "rich": 2, "runtimeerror": 2, "safari": 2, "sampl": 2, "save": 2, "save_dataset": [1, 2], "save_html": 2, "scatter": 2, "score": 2, "search": [0, 1, 2], "search_queri": 2, "see": [], "self": 2, "sen": 2, "sentenc": 2, "sentencetransform": 2, "shot": 2, "should": 2, "show": 2, "significantli": 2, "similar": 2, "similarity_search": [0, 1], "similaritysearch": [1, 2], "size": 2, "sne": 2, "sont": 2, "sourc": 2, "space": 2, "specif": 2, "specifi": 2, "split": 2, "state": 2, "step": 2, "storag": 2, "store": 2, "str": 2, "string": 2, "structur": 2, "submodul": 1, "subsequ": 2, "suit": 2, "syntax": [], "system_prompt": 2, "t": 2, "tailor": 2, "techniqu": 2, "tensor": 2, "text": 2, "them": 2, "thi": 2, "titl": 2, "token": [1, 2], "top": 2, "top_k": 2, "top_k_indic": 2, "top_k_scor": 2, "track": 2, "true": 2, "tsdae": 2, "tsne": 2, "tupl": 2, "two": 2, "type": 2, "ubinari": 2, "ubinary_embed": 2, "umap": 2, "underli": 2, "uniform": 2, "union": 2, "unsign": 2, "unsupport": 2, "upload": 2, "upload_dataset": [1, 2], "us": 2, "usearch": 2, "usearch_int8": 2, "user": 2, "user_ag": 2, "util": 2, "valu": 2, "valueerror": 2, "vari": 2, "vector": [1, 2], "view": 2, "visual": [1, 2], "web_rag": [0, 1], "webrag": [1, 2], "well": 2, "when": 2, "where": 2, "whether": 2, "which": 2, "win64": 2, "window": 2, "would": 2, "x64": 2, "yet": 2, "your": []}, "titles": ["RAGoon documentation", "ragoon", "ragoon package"], "titleterms": {"content": 2, "document": 0, "embed": 2, "indic": 0, "modul": [0, 2], "packag": [0, 2], "ragoon": [0, 1, 2], "similarity_search": 2, "submodul": [0, 2], "tabl": 0, "web_rag": 2}}) \ No newline at end of file diff --git a/docs/source/api_reference.rst b/docs/source/api_reference.rst new file mode 100644 index 0000000..7a8a842 --- /dev/null +++ b/docs/source/api_reference.rst @@ -0,0 +1,10 @@ +API Reference +============= + +This section provides the API reference for the RAGoon project. + +.. toctree:: + :maxdepth: 4 + :glob: + + ragoon/* diff --git a/docs/source/conf.py b/docs/source/conf.py index 911e6bc..7280ab9 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -39,6 +39,8 @@ html_static_path = ['_static'] html_theme_options = { + "show_nav_level": 2, # Controls the number of navigation levels to show + "navigation_depth": 4, # Adjust the depth of navigation levels "external_links": [ {"name": "GitHub", "url": "https://github.com/louisbrulenaudet"}, {"name": "Twitter", "url": "https://x.com/louisbrulenaudet"} diff --git a/docs/source/index.rst b/docs/source/index.rst index de44599..3c3568e 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -10,11 +10,11 @@ Contents: .. toctree:: :maxdepth: 2 - :caption: Modules: + :caption: Contents: + introduction modules api_reference - ragoon Indices and tables ================== diff --git a/docs/source/introduction.rst b/docs/source/introduction.rst new file mode 100644 index 0000000..2a1cab4 --- /dev/null +++ b/docs/source/introduction.rst @@ -0,0 +1,8 @@ +Introduction +============ + +Welcome to the RAGoon documentation. This section provides an overview of the project. + +.. contents:: Table of Contents + :local: + :depth: 2