-
-

LLMs

+
+

`LLMs

+
+

GRAG offers two ways to run LLMs locally:

  1. LlamaCPP

  2. HuggingFace

-

To run LLMs using HuggingFace

+

To run LLMs using HuggingFace

This is the easiest way to get started, but does not offer as much flexibility. If using a config file (config.ini), just change the model_name to @@ -108,11 +108,11 @@

To run LLMs using HuggingFace -

To run LLMs using LlamaCPP

+

To run LLMs using LlamaCPP

LlamaCPP requires models in the form of .gguf file. You can either download these model files online, or

-

How to quantize models.

+

How to quantize models.

To quantize the model, run:

python -m grag.quantize.quantize

@@ -128,7 +128,6 @@

How to quantize models.

3.Finally, the user will be prompted to enter quantization settings (recommended Q5_K_M or Q4_K_M, etc.). For more details, check llama.cpp/examples/quantize/quantize.cpp.

-
diff --git a/src/docs/_build/html/get_started.vectordb.html b/src/docs/_build/html/get_started.vectordb.html index 60a2eea..8c37e60 100644 --- a/src/docs/_build/html/get_started.vectordb.html +++ b/src/docs/_build/html/get_started.vectordb.html @@ -26,7 +26,7 @@ - + @@ -51,8 +51,10 @@

Contents:

  • Get Started
      +
    • GRAG Overview
    • Installation
    • -
    • LLMs
    • +
    • To run LLMs using HuggingFace
    • +
    • To run LLMs using LlamaCPP
    • Vector Stores
      • Supported Vector Stores
        • Chroma
        • @@ -94,7 +96,7 @@
          -

          Vector Stores

          +

          Vector Stores

          Vector store or vector database is a type of database that stores data in high-dimensional vectors. This is a crucial component of RAG, storing embeddings for both retrieval and generation processes.

          @@ -149,7 +151,7 @@

          Data Ingestion - +

          diff --git a/src/docs/_build/html/index.html b/src/docs/_build/html/index.html index d682dd6..ce2749d 100644 --- a/src/docs/_build/html/index.html +++ b/src/docs/_build/html/index.html @@ -89,8 +89,10 @@

          Welcome to GRAG’s documentation!Contents:

          • Get Started
          • diff --git a/src/docs/_build/html/objects.inv b/src/docs/_build/html/objects.inv index cf01369e36061f143705027db26a2870a7dfce55..6025fb3879ead8e56a937684b7666c7470d61dd0 100644 GIT binary patch delta 3064 zcmV>#7?xw5UJsnXUQ|_9vmxL0OnMCn2 z67}%Pzv18Wm-tEoAprsbqP(c?Ord+u(d$aw3wf!~#VcQrSrOMM_TGCJC}WXD1xTNq%vI68u%gi&8|0_kUp=&Jw393(s{P(WJ;3 zG@`UhPBq2u;Gumu-3gn%mUuOEnr53u2ke8pyRWN8q_GWR{FFpE%uu4WOFxhMPZII-b-awl(?d= zCZr^OKZ{i&dVjUSno^aACq$#`=GNt5L|+`BT*^93(JQXDcQ{4laXSdkpl=batM%(W zt5cdh;V7&ySmP&LZCd_AxZs-#yx1p90R{-gaTpg7S+|&`v3G>NU>Zi(I)B^?9E9%y z4Z8~_bO+=M&Y9*giODYL`*rtzz1<*_@LUy{(7#9LB!6)Ty}u9eBYt)0m{jb&CL-Gc zNr@u7k8aJ$x`!uan$W$x76+%hNvB1HcZ8M)68HGDD8t8nprIVZ$EVfkC8`LtJw9*R z)g?-B&pzGXepx#oVI{>adLiL zx12`+L4RL`A{r(coD)Qc@cTuly`qsgMHaG)nwB;AxukN6ou6?PQgljjNN80@o6glE z1pMCboTS*h2_1w18lSGoPZKIT)-4ym~5uGoB=Sc5XF~Q zmzZ2E0u-LqjtmFd? z|G}_Wp(pY83-O61?hm%O%!6z?%#5NYIdiFSV7Jx#!4^41`K1PL;#O~(X4?Xtqo^Ww z#cBZ>bJjSG$vzbMIl1hCyocsCFz61k*}|>on>BD*;dAn0Ifs95i%N>RiX3+Vsn7OG z|9@bMx+$&4<x!ywr$f7 z);j+`&q6Np`bqqkdB7zOAGW9W^N4UBchP&hY#KZ47CUScOZNvDmk+aO-GS7BG=iS6 zi$Pwn13)9cpT)EG(}4EFJlc{o?0jRTTYuKP;MOjbsJgpx2HSS&azK6$rN%c`-wA0* z!7uRbL4jSoCz;^_o)8F&CtRf)^5nAwB>5NK1AWlts|aeEq}!fJ;Rvud=W*j@WuRC- z0kTw&$Tvxsy&i{9I3mh${u&%Ler)Wbw$f~0$%-dL@D7l{-}$%Ok5g+!hqlMGOn(-y zhu;_7E{C}qAC3f=;(f54OOLML`B50936wjYhZ=Tp!@u1~A_tSwOyGWoPI0{<)xHxz zC+jA~)P~}St4LF9^^~A%zR>2x?S|B?XP6*b{_Le|UaN;PU6b0})4Jh&%Vl^i$Qvy} z7HHtNDB)W!{j#Xuh>2ptPm_7)X@6XdU5qi@F+SpbcF`Vsa0}n>;JeeEbehEdZaT;J z#&ph?^9-T$1A>2|Z5A=`Dsv*vca=~)vy-uPyC-+Hy|xGl{v+duAR;1uDt zk+4d0VSF3-XN_{&1dDXD_R6%~b^t>#Xo+=js*{w@PX4|}^SVbr@}eV}pnuMoMpv=C z!U~tgdL%Y?TRj`0+OOTRx5OEJS9k%QA4iD z6D6J~vY^(VNn66LKdGRS!xf)hvRBc(udsw(ma@$v`!!8Q4xfBiDov|-(LfExeCE*M*=S$8fG!NJCkQM2hWdr)DDZ%L=l7~1tK zcb7hRLh%VcgyIAs_J5|M_~Nw(Tq}QQ_C*H)=eKZ^u4zQt89x*7BDyvx^jYajkwd4| zs%(M#a%Y^`h;HGT*f0vGl(bH1p;pDi9a=EI1DkbvBhrKiJ2t*g9M_hKQheY+eD(#* zghLz=!rj|ZxWzRxI`??s9~%*7SJ`RcKH@09dr|8e7VrNO!+-BE=ACM%WVnovQGW&7 zi845Zg97IZxH%V5wSMMOCrwvL7stx%y362{4;qxxYj)0B)22DzPNT;(+A145Z(ZS} zE7#O)9ZDPbzI-&p>Af>lwo5~wiz-K(L08ZYUHuOCg7cAMc3Ub`d|@BovHN*KQAKgA zYFCOy?a!FPiht(?s!fpO@F`7^^tmGdYMqw5D>1?y2iQtWCeRO>-2@e_;Fdp{R^HWV z`hmHdpJDbqCHUEhcVxFgUeQ#W(%!>AFhgG&TCz0@38g-&FKnNJ!GytPzsE4sb$$8~ zBws=LCNKXei9XBAn!q&8h^brIHPM~F6kb*5-re0-;(yibZ71)i`f`E)KcNT@@Q&Bw z*`tLg!*e|FKmv0MCDQ>+eYk~eO?_eN{WOj^q^3eCZz?% za&jCnMt>BUj)P`kW~H9{7)W>K8zqui1Y%2~SjgW@GIR^6OP1b+WhRO|9#OYulIFfB z_Z#yE32QMltC)2@Bg+v!d+Po(3N1V%rhZ#f+l`p3Ri|Maed6A8@S|bwhI$$jjt zHY2V)Xg8J3ORsaX7Knx+=pdxi9ni2}oLf!6jA7p#fG(O%69nzti41e+$kQes`+<$s zZGY%~ql3TH?cLvg8q##}>vbH$Uc`6?=-u7rYJ!p95tBEU13vz~zI^z9HK+a#0eii` zYu_&zP>SU6YARv=EBkiJ^K5K9;oCNJnRQi$5BL9OAas zG>!6n-*1+dV)p*leAA6AS~i;4*O^D#CVwe3fm7HliE5BJxn<}m6Z?dOGfmU^whpK0 z*cnZp)8sJ?{zS0QYwPRG{apP>exJwbbj115GvSVp8N-~>$1ZCcCWl6vnMdV#8E2F+ zgYK|v(cXSr2kjihvXr>dKX3}J1hczl#`)iW|A%;O$ef1(ek06}@NW`9Q&1jz&3})r zXi}6IR#Vl7s(w@T%fPyUeeU>~_TTl{jU-^a`!hG!cxd=&BovvL+2GuHT~zem9*t zvrmsL58G~u&64u^5?<0O)Z?ZyA%75#X61tNb#o?;G5f&m>yIpS35=H6SDAfa?j`N) zo1kUymbYOfQD@%>jazBOAeU#~oF*B!xE*Q|&%Ob|iYXt-^4W`Sl68wkt4Th4(M>uK z*tA@ryi1zL+0SwrAbQ--rr4Sr{Jer{GTx%kp>sb5hORH2^gnsM&qxg426 zwaVvrc{DH+b3#p}*+^d2*;W}e8|BNoJT9Jd{=;?uKcC)8Snk~YHSO5ZvD>#~;Ne#_ z#i>)b7vFjJRjQqOb$ivFdtas6p>wy_EWP}^{nJ delta 2166 zcmV-+2#NR27}61tbAOymbKEu(fbaShv*ldLSoS`Bi>1WnD!Ep%_i;pFNDK!xd@TV= znw;`C^7ryfwgK>k8Ik}=Ksl&91leCVnm~6GAe~e=*_G!HSrOMM*}dH*&=4MZmcCI< z!FRjhMm9!8Ru(zQIlC6<&zWRHlI=+x(>!rQ34a{&q7*Z>yMGq(vylne**+*L8XlLX%U^6PYs;BIPHOSF+H5uP3I9H*jM3*Bbq^- zpd2Ef7k{04MN{IGtjsQIUe*xjXyufhA4r8b-lqgHUe(d2x_U%`eD*uglsLPa(8OuG zO5uiB6%k=00hecp5l|=|45A}Ee5`ld7=M<$;H;E48vcRXVnwI%yM=sa$$f9j z6%k}pF*8b~xd^FHu-n>uYfDaXp41Rc+}fL_*|vqwQL0+I5?29D1Z$GU%#VuvKocKi zA2zoOgYJk;3b!6_*5I-t2l`?;hW~6!Wkp>@j$Od&gT1AHv88TWSR5rj;grS@AJH(N zt$$53Q|ycJuo}NT_pC}fH2$lRxF~MZ_-|%lQDxhbez-RH|J{gO6!mHR4>NE{z=!no z)=Y$Y+=chNBn=PQ!b6%^njhf4+!|?pLF&LXhM$Owo4gbpLT~uIOlcrsZbwdc0q{-5%y@K9mH66F+R{rbkDJ{C^ll zDTQ{&<4|LVck<}2Q{-S!PAhOfLg#e7qAI@wKv&iein)a1NLP`j#Of_U*ZPo6#qCC^ z+sH7ZX!*OBuJu~Il<8Wj%`>eVov%3!j|F?BNhlT?fMchbbbnrn`)q2`_sZ&=PiKQd=hMri&qsDO=yaRx49dJF zJZs&qlb*F=$BECN_qAt>$FyY7Z2!93gif`*HnObJoET37|EqD%o5dnstUWU?w;eFC z7_>w>+}AXfqf>tG(R}W4x$>eDr%(sNqobN$s3K*to+QR@YtKehd)QBVOMlMj$6}Ko zjETQJW;8+@$xi-?Jmd69T&S#xaLK-V}BpeJSHzY#^Vnu-ov~PZg<)R-%ES|{O{$ZiX<)xE*RZ~ zySt(|?ctBzOrctv(Vd)z&ECAQLVPhXW5cMRv}vbWcB;ujwf;`p65aZn3Pa^^CJ?9W zt!TbiSfXBuD82VZRA-`y_$(VCTANj>S+q!{5>YC@D)BoJ@yyEP$bVj>OG+qJ-=y%o zrhWh$6!gP)(NJXxw34Wni))-_gxM&&mTJa{d=~)Av?`k~^vW0fAv6V_{{7k1wd-r! z8`Q)%abmKEnsgr$F%&j-8a0^<%{#bYPTvxz8U(HUisoI32Hxxam5_WSI<~Fq>d)fm zjVQwy#}y~>P{*KIU4Q+Fa2V6FVJH*Q9DYF^C(WM#46kW*_bnGVUP1X3&ExuO8so%# z_$N5}iIQiH2Zafn;)ruf{^8*Z)5N+h#tBjFA!DaDg}^=VjKXA|)8yJDCe6J1zXvX_ zyx0Mi!$TcUZ-mY;#w@-6s6P{3iVq)&x^$pF4_%6A1@`Xe=6|TKvM;aid?H+OHNpp@ z^uHv9-jE$Hr2BsV^*6SQo6I4H&!29fXdD^r~Ychm7|A-TEGapp!BL^#wFDOYNu4yqsR$KveN&ON()I&t` z(n)!?E2E}Mn144ya{!tHy}s%+2d(B{s5t=57sZc#7Y^i^LBX=N57(v8f=+0<2fete zqU^iV)JBW@F{r5)bU;Z7%SY-kd!w7`YO&FSs%(MLN=g{5RdV*`sse4XwS8T;z*s3H zY#o+@MpGvufzj597-6=TB|#?`D23K>rE2S&q^3wOs&D3fY^cVjtRCtMI^m&e6(F2Az-<6?Si!t&rAtm%ixz;54@s|dfUD^7#Dz43i?UuCt^ ssBUj{AKq74?J&68+uTKYv&sIW<%HSuVRK-(DIOYwo>gS~KUl)E$F9FUzyJUM diff --git a/src/docs/_build/html/searchindex.js b/src/docs/_build/html/searchindex.js index 4f22741..79265bf 100644 --- a/src/docs/_build/html/searchindex.js +++ b/src/docs/_build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"Base": [[18, "module-grag.components.vectordb.base"]], "Basic RAG": [[21, "module-grag.rag.basic_rag"]], "Basic-RAG Cookbooks": [[5, "basic-rag-cookbooks"]], "Chroma": [[15, "chroma"]], "Chroma Client": [[18, "module-grag.components.vectordb.chroma_client"]], "Components": [[17, "components"]], "Computation times": [[6, "computation-times"], [9, "computation-times"], [24, "computation-times"]], "Contents:": [[22, null]], "Cookbooks": [[10, "cookbooks"]], "Custom Few-Shot Prompts": [[1, "custom-few-shot-prompts"]], "Custom Prompts": [[0, "custom-prompts"]], "Data Ingestion": [[15, "data-ingestion"]], "Deeplake Client": [[18, "module-grag.components.vectordb.deeplake_client"]], "Document Ingestion": [[2, "document-ingestion"]], "Embedding": [[17, "module-grag.components.embedding"]], "Embeddings": [[15, "embeddings"]], "GRAG": [[16, "grag"]], "GRAG Overview": [[13, "grag-overview"]], "Get Started": [[11, "get-started"]], "How to quantize models.": [[14, "how-to-quantize-models"]], "Indices and tables": [[22, "indices-and-tables"]], "Installation": [[12, "installation"]], "LLM": [[17, "module-grag.components.llm"]], "LLMs": [[14, "llms"]], "Module Contents": [[18, "module-grag.components.vectordb"]], "Module contents": [[16, "module-grag"], [17, "module-grag.components"], [19, "module-grag.prompts"], [20, "module-grag.quantize"], [21, "module-grag.rag"]], "Parse PDF": [[17, "module-grag.components.parse_pdf"]], "Prompt": [[17, "module-grag.components.prompt"]], "Prompts": [[19, "prompts"]], "Quantize": [[20, "quantize"], [20, "id1"]], "RAG": [[21, "rag"]], "Refine Chain": [[3, "refine-chain"]], "Retrieval-Augmented Generation": [[13, "retrieval-augmented-generation"]], "Retriever": [[17, "module-grag.components.multivec_retriever"]], "Retriever GUI": [[8, "retriever-gui"]], "Retriever-GUI Cookbooks": [[7, "retriever-gui-cookbooks"]], "Stuff Chain": [[4, "stuff-chain"]], "Submodules": [[18, "submodules"], [20, "submodules"], [21, "submodules"]], "Supported Vector Stores": [[15, "supported-vector-stores"]], "Text Splitter": [[17, "module-grag.components.text_splitter"]], "To run LLMs using HuggingFace": [[14, "to-run-llms-using-huggingface"]], "To run LLMs using LlamaCPP": [[14, "to-run-llms-using-llamacpp"]], "Utils": [[17, "module-grag.components.utils"], [20, "module-grag.quantize.utils"]], "Vector Stores": [[15, "vector-stores"]], "VectorDB": [[17, "vectordb"], [18, "vectordb"]], "Welcome to GRAG\u2019s documentation!": [[22, "welcome-to-grag-s-documentation"]], "grag": [[23, "grag"]]}, "docnames": ["auto_examples/Basic-RAG/BasicRAG_CustomPrompt", "auto_examples/Basic-RAG/BasicRAG_FewShotPrompt", "auto_examples/Basic-RAG/BasicRAG_ingest", "auto_examples/Basic-RAG/BasicRAG_refine", "auto_examples/Basic-RAG/BasicRAG_stuff", "auto_examples/Basic-RAG/index", "auto_examples/Basic-RAG/sg_execution_times", "auto_examples/Retriver-GUI/index", "auto_examples/Retriver-GUI/retriever_app", "auto_examples/Retriver-GUI/sg_execution_times", "auto_examples_index", "get_started", "get_started.installation", "get_started.introduction", "get_started.llms", "get_started.vectordb", "grag", "grag.components", "grag.components.vectordb", "grag.prompts", "grag.quantize", "grag.rag", "index", "modules", "sg_execution_times"], "envversion": {"sphinx": 61, "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.todo": 2}, "filenames": ["auto_examples/Basic-RAG/BasicRAG_CustomPrompt.rst", "auto_examples/Basic-RAG/BasicRAG_FewShotPrompt.rst", "auto_examples/Basic-RAG/BasicRAG_ingest.rst", "auto_examples/Basic-RAG/BasicRAG_refine.rst", "auto_examples/Basic-RAG/BasicRAG_stuff.rst", "auto_examples/Basic-RAG/index.rst", "auto_examples/Basic-RAG/sg_execution_times.rst", "auto_examples/Retriver-GUI/index.rst", "auto_examples/Retriver-GUI/retriever_app.rst", "auto_examples/Retriver-GUI/sg_execution_times.rst", "auto_examples_index.rst", "get_started.rst", "get_started.installation.rst", "get_started.introduction.rst", "get_started.llms.rst", "get_started.vectordb.rst", "grag.rst", "grag.components.rst", "grag.components.vectordb.rst", "grag.prompts.rst", "grag.quantize.rst", "grag.rag.rst", "index.rst", "modules.rst", "sg_execution_times.rst"], "indexentries": {"aadd_docs() (grag.components.multivec_retriever.retriever method)": [[17, "grag.components.multivec_retriever.Retriever.aadd_docs", false]], "aadd_docs() (grag.components.vectordb.base.vectordb method)": [[18, "grag.components.vectordb.base.VectorDB.aadd_docs", false]], "aadd_docs() (grag.components.vectordb.chroma_client.chromaclient method)": [[18, "grag.components.vectordb.chroma_client.ChromaClient.aadd_docs", false]], "aadd_docs() (grag.components.vectordb.deeplake_client.deeplakeclient method)": [[18, "grag.components.vectordb.deeplake_client.DeepLakeClient.aadd_docs", false]], "add_caption_first (grag.components.parse_pdf.parsepdf attribute)": [[17, "grag.components.parse_pdf.ParsePDF.add_caption_first", false]], "add_captions_to_blocks (grag.components.parse_pdf.parsepdf attribute)": [[17, "grag.components.parse_pdf.ParsePDF.add_captions_to_blocks", false]], "add_captions_to_text (grag.components.parse_pdf.parsepdf attribute)": [[17, "grag.components.parse_pdf.ParsePDF.add_captions_to_text", false]], "add_docs() (grag.components.multivec_retriever.retriever method)": [[17, "grag.components.multivec_retriever.Retriever.add_docs", false]], "add_docs() (grag.components.vectordb.base.vectordb method)": [[18, "grag.components.vectordb.base.VectorDB.add_docs", false]], "add_docs() (grag.components.vectordb.chroma_client.chromaclient method)": [[18, "grag.components.vectordb.chroma_client.ChromaClient.add_docs", false]], "add_docs() (grag.components.vectordb.deeplake_client.deeplakeclient method)": [[18, "grag.components.vectordb.deeplake_client.DeepLakeClient.add_docs", false]], "aget_chunk() (grag.components.multivec_retriever.retriever method)": [[17, "grag.components.multivec_retriever.Retriever.aget_chunk", false]], "aget_chunk() (grag.components.vectordb.base.vectordb method)": [[18, "grag.components.vectordb.base.VectorDB.aget_chunk", false]], "aget_chunk() (grag.components.vectordb.chroma_client.chromaclient method)": [[18, "grag.components.vectordb.chroma_client.ChromaClient.aget_chunk", false]], "aget_chunk() (grag.components.vectordb.deeplake_client.deeplakeclient method)": [[18, "grag.components.vectordb.deeplake_client.DeepLakeClient.aget_chunk", false]], "aget_doc() (grag.components.multivec_retriever.retriever method)": [[17, "grag.components.multivec_retriever.Retriever.aget_doc", false]], "aingest() (grag.components.multivec_retriever.retriever method)": [[17, "grag.components.multivec_retriever.Retriever.aingest", false]], "basicrag (class in grag.rag.basic_rag)": [[21, "grag.rag.basic_rag.BasicRAG", false]], "building_llamacpp() (in module grag.quantize.utils)": [[20, "grag.quantize.utils.building_llamacpp", false]], "chromaclient (class in grag.components.vectordb.chroma_client)": [[18, "grag.components.vectordb.chroma_client.ChromaClient", false]], "chunk_overlap (grag.components.text_splitter.textsplitter attribute)": [[17, "grag.components.text_splitter.TextSplitter.chunk_overlap", false]], "chunk_size (grag.components.text_splitter.textsplitter attribute)": [[17, "grag.components.text_splitter.TextSplitter.chunk_size", false]], "classify() (grag.components.parse_pdf.parsepdf method)": [[17, "grag.components.parse_pdf.ParsePDF.classify", false]], "client (grag.components.vectordb.chroma_client.chromaclient attribute)": [[18, "grag.components.vectordb.chroma_client.ChromaClient.client", false]], "client (grag.components.vectordb.deeplake_client.deeplakeclient attribute)": [[18, "grag.components.vectordb.deeplake_client.DeepLakeClient.client", false]], "collection (grag.components.vectordb.chroma_client.chromaclient attribute)": [[18, "grag.components.vectordb.chroma_client.ChromaClient.collection", false]], "collection (grag.components.vectordb.deeplake_client.deeplakeclient attribute)": [[18, "grag.components.vectordb.deeplake_client.DeepLakeClient.collection", false]], "collection_name (grag.components.vectordb.chroma_client.chromaclient attribute)": [[18, "grag.components.vectordb.chroma_client.ChromaClient.collection_name", false]], "custom_prompt (grag.rag.basic_rag.basicrag attribute)": [[21, "grag.rag.basic_rag.BasicRAG.custom_prompt", false]], "deeplakeclient (class in grag.components.vectordb.deeplake_client)": [[18, "grag.components.vectordb.deeplake_client.DeepLakeClient", false]], "delete() (grag.components.vectordb.base.vectordb method)": [[18, "grag.components.vectordb.base.VectorDB.delete", false]], "delete() (grag.components.vectordb.chroma_client.chromaclient method)": [[18, "grag.components.vectordb.chroma_client.ChromaClient.delete", false]], "delete() (grag.components.vectordb.deeplake_client.deeplakeclient method)": [[18, "grag.components.vectordb.deeplake_client.DeepLakeClient.delete", false]], "device_map (grag.components.llm.llm attribute)": [[17, "grag.components.llm.LLM.device_map", false]], "doc_chain (grag.components.prompt.fewshotprompt attribute)": [[17, "grag.components.prompt.FewShotPrompt.doc_chain", false]], "doc_chain (grag.components.prompt.prompt attribute)": [[17, "grag.components.prompt.Prompt.doc_chain", false], [17, "id6", false]], "doc_chain (grag.rag.basic_rag.basicrag attribute)": [[21, "grag.rag.basic_rag.BasicRAG.doc_chain", false]], "doc_chain (grag.rag.basic_rag.basicrag property)": [[21, "id0", false]], "embedding (class in grag.components.embedding)": [[17, "grag.components.embedding.Embedding", false]], "embedding_function (grag.components.embedding.embedding attribute)": [[17, "grag.components.embedding.Embedding.embedding_function", false]], "embedding_function (grag.components.vectordb.chroma_client.chromaclient attribute)": [[18, "grag.components.vectordb.chroma_client.ChromaClient.embedding_function", false]], "embedding_function (grag.components.vectordb.deeplake_client.deeplakeclient attribute)": [[18, "grag.components.vectordb.deeplake_client.DeepLakeClient.embedding_function", false]], "embedding_model (grag.components.embedding.embedding attribute)": [[17, "grag.components.embedding.Embedding.embedding_model", false]], "embedding_model (grag.components.vectordb.chroma_client.chromaclient attribute)": [[18, "grag.components.vectordb.chroma_client.ChromaClient.embedding_model", false]], "embedding_model (grag.components.vectordb.deeplake_client.deeplakeclient attribute)": [[18, "grag.components.vectordb.deeplake_client.DeepLakeClient.embedding_model", false]], "embedding_type (grag.components.embedding.embedding attribute)": [[17, "grag.components.embedding.Embedding.embedding_type", false]], "embedding_type (grag.components.vectordb.chroma_client.chromaclient attribute)": [[18, "grag.components.vectordb.chroma_client.ChromaClient.embedding_type", false]], "embedding_type (grag.components.vectordb.deeplake_client.deeplakeclient attribute)": [[18, "grag.components.vectordb.deeplake_client.DeepLakeClient.embedding_type", false]], "example_template (grag.components.prompt.fewshotprompt attribute)": [[17, "grag.components.prompt.FewShotPrompt.example_template", false], [17, "id2", false]], "examples (grag.components.prompt.fewshotprompt attribute)": [[17, "grag.components.prompt.FewShotPrompt.examples", false], [17, "id3", false]], "extract_image_block_types (grag.components.parse_pdf.parsepdf attribute)": [[17, "grag.components.parse_pdf.ParsePDF.extract_image_block_types", false]], "extract_images (grag.components.parse_pdf.parsepdf attribute)": [[17, "grag.components.parse_pdf.ParsePDF.extract_images", false]], "fetch_model_repo() (in module grag.quantize.utils)": [[20, "grag.quantize.utils.fetch_model_repo", false]], "fewshotprompt (class in grag.components.prompt)": [[17, "grag.components.prompt.FewShotPrompt", false]], "filepath (grag.components.prompt.fewshotprompt attribute)": [[17, "grag.components.prompt.FewShotPrompt.filepath", false]], "filepath (grag.components.prompt.prompt attribute)": [[17, "grag.components.prompt.Prompt.filepath", false], [17, "id7", false]], "find_config_path() (in module grag.components.utils)": [[17, "grag.components.utils.find_config_path", false]], "format() (grag.components.prompt.prompt method)": [[17, "grag.components.prompt.Prompt.format", false]], "gen_doc_ids() (grag.components.multivec_retriever.retriever method)": [[17, "grag.components.multivec_retriever.Retriever.gen_doc_ids", false]], "get_chunk() (grag.components.multivec_retriever.retriever method)": [[17, "grag.components.multivec_retriever.Retriever.get_chunk", false]], "get_chunk() (grag.components.vectordb.base.vectordb method)": [[18, "grag.components.vectordb.base.VectorDB.get_chunk", false]], "get_chunk() (grag.components.vectordb.chroma_client.chromaclient method)": [[18, "grag.components.vectordb.chroma_client.ChromaClient.get_chunk", false]], "get_chunk() (grag.components.vectordb.deeplake_client.deeplakeclient method)": [[18, "grag.components.vectordb.deeplake_client.DeepLakeClient.get_chunk", false]], "get_config() (in module grag.components.utils)": [[17, "grag.components.utils.get_config", false]], "get_doc() (grag.components.multivec_retriever.retriever method)": [[17, "grag.components.multivec_retriever.Retriever.get_doc", false]], "get_docs_from_chunks() (grag.components.multivec_retriever.retriever method)": [[17, "grag.components.multivec_retriever.Retriever.get_docs_from_chunks", false]], "get_llamacpp_repo() (in module grag.quantize.utils)": [[20, "grag.quantize.utils.get_llamacpp_repo", false]], "grag": [[16, "module-grag", false]], "grag.components": [[17, "module-grag.components", false]], "grag.components.embedding": [[17, "module-grag.components.embedding", false]], "grag.components.llm": [[17, "module-grag.components.llm", false]], "grag.components.multivec_retriever": [[17, "module-grag.components.multivec_retriever", false]], "grag.components.parse_pdf": [[17, "module-grag.components.parse_pdf", false]], "grag.components.prompt": [[17, "module-grag.components.prompt", false]], "grag.components.text_splitter": [[17, "module-grag.components.text_splitter", false]], "grag.components.utils": [[17, "module-grag.components.utils", false]], "grag.components.vectordb": [[18, "module-grag.components.vectordb", false]], "grag.components.vectordb.base": [[18, "module-grag.components.vectordb.base", false]], "grag.components.vectordb.chroma_client": [[18, "module-grag.components.vectordb.chroma_client", false]], "grag.components.vectordb.deeplake_client": [[18, "module-grag.components.vectordb.deeplake_client", false]], "grag.prompts": [[19, "module-grag.prompts", false]], "grag.quantize": [[20, "module-grag.quantize", false]], "grag.quantize.quantize": [[20, "module-grag.quantize.quantize", false]], "grag.quantize.utils": [[20, "module-grag.quantize.utils", false]], "grag.rag": [[21, "module-grag.rag", false]], "grag.rag.basic_rag": [[21, "module-grag.rag.basic_rag", false]], "hf_pipeline() (grag.components.llm.llm method)": [[17, "grag.components.llm.LLM.hf_pipeline", false]], "host (grag.components.vectordb.chroma_client.chromaclient attribute)": [[18, "grag.components.vectordb.chroma_client.ChromaClient.host", false]], "id_gen() (grag.components.multivec_retriever.retriever method)": [[17, "grag.components.multivec_retriever.Retriever.id_gen", false]], "id_key (grag.components.multivec_retriever.retriever attribute)": [[17, "grag.components.multivec_retriever.Retriever.id_key", false]], "image_output_dir (grag.components.parse_pdf.parsepdf attribute)": [[17, "grag.components.parse_pdf.ParsePDF.image_output_dir", false]], "infer_table_structure (grag.components.parse_pdf.parsepdf attribute)": [[17, "grag.components.parse_pdf.ParsePDF.infer_table_structure", false]], "ingest() (grag.components.multivec_retriever.retriever method)": [[17, "grag.components.multivec_retriever.Retriever.ingest", false]], "input_keys (grag.components.prompt.fewshotprompt attribute)": [[17, "grag.components.prompt.FewShotPrompt.input_keys", false], [17, "id1", false]], "input_keys (grag.components.prompt.prompt attribute)": [[17, "grag.components.prompt.Prompt.input_keys", false], [17, "id8", false]], "langchain_client (grag.components.vectordb.chroma_client.chromaclient attribute)": [[18, "grag.components.vectordb.chroma_client.ChromaClient.langchain_client", false]], "langchain_client (grag.components.vectordb.deeplake_client.deeplakeclient attribute)": [[18, "grag.components.vectordb.deeplake_client.DeepLakeClient.langchain_client", false]], "language (grag.components.prompt.fewshotprompt attribute)": [[17, "grag.components.prompt.FewShotPrompt.language", false]], "language (grag.components.prompt.prompt attribute)": [[17, "grag.components.prompt.Prompt.language", false], [17, "id9", false]], "llama_cpp() (grag.components.llm.llm method)": [[17, "grag.components.llm.LLM.llama_cpp", false]], "llm (class in grag.components.llm)": [[17, "grag.components.llm.LLM", false]], "llm_kwargs (grag.rag.basic_rag.basicrag attribute)": [[21, "grag.rag.basic_rag.BasicRAG.llm_kwargs", false]], "llm_type (grag.components.prompt.fewshotprompt attribute)": [[17, "grag.components.prompt.FewShotPrompt.llm_type", false]], "llm_type (grag.components.prompt.prompt attribute)": [[17, "grag.components.prompt.Prompt.llm_type", false], [17, "id10", false]], "load() (grag.components.prompt.prompt class method)": [[17, "grag.components.prompt.Prompt.load", false]], "load_file() (grag.components.parse_pdf.parsepdf method)": [[17, "grag.components.parse_pdf.ParsePDF.load_file", false]], "load_model() (grag.components.llm.llm method)": [[17, "grag.components.llm.LLM.load_model", false]], "max_new_tokens (grag.components.llm.llm attribute)": [[17, "grag.components.llm.LLM.max_new_tokens", false]], "model_computed_fields (grag.components.prompt.fewshotprompt attribute)": [[17, "grag.components.prompt.FewShotPrompt.model_computed_fields", false]], "model_computed_fields (grag.components.prompt.prompt attribute)": [[17, "grag.components.prompt.Prompt.model_computed_fields", false]], "model_config (grag.components.prompt.fewshotprompt attribute)": [[17, "grag.components.prompt.FewShotPrompt.model_config", false]], "model_config (grag.components.prompt.prompt attribute)": [[17, "grag.components.prompt.Prompt.model_config", false]], "model_fields (grag.components.prompt.fewshotprompt attribute)": [[17, "grag.components.prompt.FewShotPrompt.model_fields", false]], "model_fields (grag.components.prompt.prompt attribute)": [[17, "grag.components.prompt.Prompt.model_fields", false]], "model_name (grag.components.llm.llm attribute)": [[17, "grag.components.llm.LLM.model_name", false]], "model_name (grag.components.llm.llm property)": [[17, "id0", false]], "model_name (grag.rag.basic_rag.basicrag attribute)": [[21, "grag.rag.basic_rag.BasicRAG.model_name", false]], "model_name (grag.rag.basic_rag.basicrag property)": [[21, "id1", false]], "model_path (grag.components.llm.llm property)": [[17, "grag.components.llm.LLM.model_path", false]], "module": [[16, "module-grag", false], [17, "module-grag.components", false], [17, "module-grag.components.embedding", false], [17, "module-grag.components.llm", false], [17, "module-grag.components.multivec_retriever", false], [17, "module-grag.components.parse_pdf", false], [17, "module-grag.components.prompt", false], [17, "module-grag.components.text_splitter", false], [17, "module-grag.components.utils", false], [18, "module-grag.components.vectordb", false], [18, "module-grag.components.vectordb.base", false], [18, "module-grag.components.vectordb.chroma_client", false], [18, "module-grag.components.vectordb.deeplake_client", false], [19, "module-grag.prompts", false], [20, "module-grag.quantize", false], [20, "module-grag.quantize.quantize", false], [20, "module-grag.quantize.utils", false], [21, "module-grag.rag", false], [21, "module-grag.rag.basic_rag", false]], "n_batch (grag.components.llm.llm attribute)": [[17, "grag.components.llm.LLM.n_batch", false]], "n_ctx (grag.components.llm.llm attribute)": [[17, "grag.components.llm.LLM.n_ctx", false]], "n_gpu_layers (grag.components.llm.llm attribute)": [[17, "grag.components.llm.LLM.n_gpu_layers", false]], "name (grag.components.prompt.fewshotprompt attribute)": [[17, "grag.components.prompt.FewShotPrompt.name", false]], "name (grag.components.prompt.prompt attribute)": [[17, "grag.components.prompt.Prompt.name", false], [17, "id11", false]], "namespace (grag.components.multivec_retriever.retriever attribute)": [[17, "grag.components.multivec_retriever.Retriever.namespace", false]], "output_keys (grag.components.prompt.fewshotprompt attribute)": [[17, "grag.components.prompt.FewShotPrompt.output_keys", false]], "output_parser() (grag.rag.basic_rag.basicrag static method)": [[21, "grag.rag.basic_rag.BasicRAG.output_parser", false]], "parsepdf (class in grag.components.parse_pdf)": [[17, "grag.components.parse_pdf.ParsePDF", false]], "partition() (grag.components.parse_pdf.parsepdf method)": [[17, "grag.components.parse_pdf.ParsePDF.partition", false]], "port (grag.components.vectordb.chroma_client.chromaclient attribute)": [[18, "grag.components.vectordb.chroma_client.ChromaClient.port", false]], "prefix (grag.components.prompt.fewshotprompt attribute)": [[17, "grag.components.prompt.FewShotPrompt.prefix", false], [17, "id4", false]], "process_images() (grag.components.parse_pdf.parsepdf method)": [[17, "grag.components.parse_pdf.ParsePDF.process_images", false]], "process_tables() (grag.components.parse_pdf.parsepdf method)": [[17, "grag.components.parse_pdf.ParsePDF.process_tables", false]], "process_text() (grag.components.parse_pdf.parsepdf method)": [[17, "grag.components.parse_pdf.ParsePDF.process_text", false]], "prompt (class in grag.components.prompt)": [[17, "grag.components.prompt.Prompt", false]], "prompt (grag.components.prompt.prompt attribute)": [[17, "grag.components.prompt.Prompt.prompt", false]], "prompt_matcher() (grag.rag.basic_rag.basicrag method)": [[21, "grag.rag.basic_rag.BasicRAG.prompt_matcher", false]], "quantize_model() (in module grag.quantize.utils)": [[20, "grag.quantize.utils.quantize_model", false]], "refine_call() (grag.rag.basic_rag.basicrag method)": [[21, "grag.rag.basic_rag.BasicRAG.refine_call", false]], "retriever (class in grag.components.multivec_retriever)": [[17, "grag.components.multivec_retriever.Retriever", false]], "retriever (grag.components.multivec_retriever.retriever attribute)": [[17, "grag.components.multivec_retriever.Retriever.retriever", false]], "retriever_kwargs (grag.rag.basic_rag.basicrag attribute)": [[21, "grag.rag.basic_rag.BasicRAG.retriever_kwargs", false]], "save() (grag.components.prompt.prompt method)": [[17, "grag.components.prompt.Prompt.save", false]], "single_text_out (grag.components.parse_pdf.parsepdf attribute)": [[17, "grag.components.parse_pdf.ParsePDF.single_text_out", false]], "source (grag.components.prompt.fewshotprompt attribute)": [[17, "grag.components.prompt.FewShotPrompt.source", false]], "source (grag.components.prompt.prompt attribute)": [[17, "grag.components.prompt.Prompt.source", false], [17, "id12", false]], "split_docs() (grag.components.multivec_retriever.retriever method)": [[17, "grag.components.multivec_retriever.Retriever.split_docs", false]], "splitter (grag.components.multivec_retriever.retriever attribute)": [[17, "grag.components.multivec_retriever.Retriever.splitter", false]], "store (grag.components.multivec_retriever.retriever attribute)": [[17, "grag.components.multivec_retriever.Retriever.store", false]], "store_path (grag.components.multivec_retriever.retriever attribute)": [[17, "grag.components.multivec_retriever.Retriever.store_path", false]], "store_path (grag.components.vectordb.deeplake_client.deeplakeclient attribute)": [[18, "grag.components.vectordb.deeplake_client.DeepLakeClient.store_path", false]], "strategy (grag.components.parse_pdf.parsepdf attribute)": [[17, "grag.components.parse_pdf.ParsePDF.strategy", false]], "stuff_call() (grag.rag.basic_rag.basicrag method)": [[21, "grag.rag.basic_rag.BasicRAG.stuff_call", false]], "stuff_docs() (grag.rag.basic_rag.basicrag static method)": [[21, "grag.rag.basic_rag.BasicRAG.stuff_docs", false]], "stuff_docs() (in module grag.components.utils)": [[17, "grag.components.utils.stuff_docs", false]], "suffix (grag.components.prompt.fewshotprompt attribute)": [[17, "grag.components.prompt.FewShotPrompt.suffix", false], [17, "id5", false]], "task (grag.components.llm.llm attribute)": [[17, "grag.components.llm.LLM.task", false]], "task (grag.components.prompt.fewshotprompt attribute)": [[17, "grag.components.prompt.FewShotPrompt.task", false]], "task (grag.components.prompt.prompt attribute)": [[17, "grag.components.prompt.Prompt.task", false], [17, "id13", false]], "task (grag.rag.basic_rag.basicrag attribute)": [[21, "grag.rag.basic_rag.BasicRAG.task", false]], "task (grag.rag.basic_rag.basicrag property)": [[21, "id2", false]], "temperature (grag.components.llm.llm attribute)": [[17, "grag.components.llm.LLM.temperature", false]], "template (grag.components.prompt.prompt attribute)": [[17, "grag.components.prompt.Prompt.template", false]], "test_connection() (grag.components.vectordb.chroma_client.chromaclient method)": [[18, "grag.components.vectordb.chroma_client.ChromaClient.test_connection", false]], "text_concat() (grag.components.parse_pdf.parsepdf method)": [[17, "grag.components.parse_pdf.ParsePDF.text_concat", false]], "text_splitter (grag.components.text_splitter.textsplitter attribute)": [[17, "grag.components.text_splitter.TextSplitter.text_splitter", false]], "textsplitter (class in grag.components.text_splitter)": [[17, "grag.components.text_splitter.TextSplitter", false]], "top_k (grag.components.multivec_retriever.retriever attribute)": [[17, "grag.components.multivec_retriever.Retriever.top_k", false]], "validate_doc_chain() (grag.components.prompt.prompt class method)": [[17, "grag.components.prompt.Prompt.validate_doc_chain", false]], "validate_examples() (grag.components.prompt.fewshotprompt class method)": [[17, "grag.components.prompt.FewShotPrompt.validate_examples", false]], "validate_input_keys() (grag.components.prompt.prompt class method)": [[17, "grag.components.prompt.Prompt.validate_input_keys", false]], "validate_output_keys() (grag.components.prompt.fewshotprompt class method)": [[17, "grag.components.prompt.FewShotPrompt.validate_output_keys", false]], "validate_task() (grag.components.prompt.prompt class method)": [[17, "grag.components.prompt.Prompt.validate_task", false]], "vectordb (class in grag.components.vectordb.base)": [[18, "grag.components.vectordb.base.VectorDB", false]], "vectordb (grag.components.multivec_retriever.retriever attribute)": [[17, "grag.components.multivec_retriever.Retriever.vectordb", false]]}, "objects": {"": [[16, 0, 0, "-", "grag"]], "grag": [[17, 0, 0, "-", "components"], [19, 0, 0, "-", "prompts"], [20, 0, 0, "-", "quantize"], [21, 0, 0, "-", "rag"]], "grag.components": [[17, 0, 0, "-", "embedding"], [17, 0, 0, "-", "llm"], [17, 0, 0, "-", "multivec_retriever"], [17, 0, 0, "-", "parse_pdf"], [17, 0, 0, "-", "prompt"], [17, 0, 0, "-", "text_splitter"], [17, 0, 0, "-", "utils"], [18, 0, 0, "-", "vectordb"]], "grag.components.embedding": [[17, 1, 1, "", "Embedding"]], "grag.components.embedding.Embedding": [[17, 2, 1, "", "embedding_function"], [17, 2, 1, "", "embedding_model"], [17, 2, 1, "", "embedding_type"]], "grag.components.llm": [[17, 1, 1, "", "LLM"]], "grag.components.llm.LLM": [[17, 2, 1, "", "device_map"], [17, 3, 1, "", "hf_pipeline"], [17, 3, 1, "", "llama_cpp"], [17, 3, 1, "", "load_model"], [17, 2, 1, "", "max_new_tokens"], [17, 4, 1, "id0", "model_name"], [17, 4, 1, "", "model_path"], [17, 2, 1, "", "n_batch"], [17, 2, 1, "", "n_ctx"], [17, 2, 1, "", "n_gpu_layers"], [17, 2, 1, "", "task"], [17, 2, 1, "", "temperature"]], "grag.components.multivec_retriever": [[17, 1, 1, "", "Retriever"]], "grag.components.multivec_retriever.Retriever": [[17, 3, 1, "", "aadd_docs"], [17, 3, 1, "", "add_docs"], [17, 3, 1, "", "aget_chunk"], [17, 3, 1, "", "aget_doc"], [17, 3, 1, "", "aingest"], [17, 3, 1, "", "gen_doc_ids"], [17, 3, 1, "", "get_chunk"], [17, 3, 1, "", "get_doc"], [17, 3, 1, "", "get_docs_from_chunks"], [17, 3, 1, "", "id_gen"], [17, 2, 1, "", "id_key"], [17, 3, 1, "", "ingest"], [17, 2, 1, "", "namespace"], [17, 2, 1, "", "retriever"], [17, 3, 1, "", "split_docs"], [17, 2, 1, "", "splitter"], [17, 2, 1, "", "store"], [17, 2, 1, "", "store_path"], [17, 2, 1, "", "top_k"], [17, 2, 1, "", "vectordb"]], "grag.components.parse_pdf": [[17, 1, 1, "", "ParsePDF"]], "grag.components.parse_pdf.ParsePDF": [[17, 2, 1, "", "add_caption_first"], [17, 2, 1, "", "add_captions_to_blocks"], [17, 2, 1, "", "add_captions_to_text"], [17, 3, 1, "", "classify"], [17, 2, 1, "", "extract_image_block_types"], [17, 2, 1, "", "extract_images"], [17, 2, 1, "", "image_output_dir"], [17, 2, 1, "", "infer_table_structure"], [17, 3, 1, "", "load_file"], [17, 3, 1, "", "partition"], [17, 3, 1, "", "process_images"], [17, 3, 1, "", "process_tables"], [17, 3, 1, "", "process_text"], [17, 2, 1, "", "single_text_out"], [17, 2, 1, "", "strategy"], [17, 3, 1, "", "text_concat"]], "grag.components.prompt": [[17, 1, 1, "", "FewShotPrompt"], [17, 1, 1, "", "Prompt"]], "grag.components.prompt.FewShotPrompt": [[17, 2, 1, "", "doc_chain"], [17, 2, 1, "id2", "example_template"], [17, 2, 1, "id3", "examples"], [17, 2, 1, "", "filepath"], [17, 2, 1, "id1", "input_keys"], [17, 2, 1, "", "language"], [17, 2, 1, "", "llm_type"], [17, 2, 1, "", "model_computed_fields"], [17, 2, 1, "", "model_config"], [17, 2, 1, "", "model_fields"], [17, 2, 1, "", "name"], [17, 2, 1, "", "output_keys"], [17, 2, 1, "id4", "prefix"], [17, 2, 1, "", "source"], [17, 2, 1, "id5", "suffix"], [17, 2, 1, "", "task"], [17, 3, 1, "", "validate_examples"], [17, 3, 1, "", "validate_output_keys"]], "grag.components.prompt.Prompt": [[17, 2, 1, "id6", "doc_chain"], [17, 2, 1, "id7", "filepath"], [17, 3, 1, "", "format"], [17, 2, 1, "id8", "input_keys"], [17, 2, 1, "id9", "language"], [17, 2, 1, "id10", "llm_type"], [17, 3, 1, "", "load"], [17, 2, 1, "", "model_computed_fields"], [17, 2, 1, "", "model_config"], [17, 2, 1, "", "model_fields"], [17, 2, 1, "id11", "name"], [17, 2, 1, "", "prompt"], [17, 3, 1, "", "save"], [17, 2, 1, "id12", "source"], [17, 2, 1, "id13", "task"], [17, 2, 1, "", "template"], [17, 3, 1, "", "validate_doc_chain"], [17, 3, 1, "", "validate_input_keys"], [17, 3, 1, "", "validate_task"]], "grag.components.text_splitter": [[17, 1, 1, "", "TextSplitter"]], "grag.components.text_splitter.TextSplitter": [[17, 2, 1, "", "chunk_overlap"], [17, 2, 1, "", "chunk_size"], [17, 2, 1, "", "text_splitter"]], "grag.components.utils": [[17, 5, 1, "", "find_config_path"], [17, 5, 1, "", "get_config"], [17, 5, 1, "", "stuff_docs"]], "grag.components.vectordb": [[18, 0, 0, "-", "base"], [18, 0, 0, "-", "chroma_client"], [18, 0, 0, "-", "deeplake_client"]], "grag.components.vectordb.base": [[18, 1, 1, "", "VectorDB"]], "grag.components.vectordb.base.VectorDB": [[18, 3, 1, "", "aadd_docs"], [18, 3, 1, "", "add_docs"], [18, 3, 1, "", "aget_chunk"], [18, 3, 1, "", "delete"], [18, 3, 1, "", "get_chunk"]], "grag.components.vectordb.chroma_client": [[18, 1, 1, "", "ChromaClient"]], "grag.components.vectordb.chroma_client.ChromaClient": [[18, 3, 1, "", "aadd_docs"], [18, 3, 1, "", "add_docs"], [18, 3, 1, "", "aget_chunk"], [18, 2, 1, "", "client"], [18, 2, 1, "", "collection"], [18, 2, 1, "", "collection_name"], [18, 3, 1, "", "delete"], [18, 2, 1, "", "embedding_function"], [18, 2, 1, "", "embedding_model"], [18, 2, 1, "", "embedding_type"], [18, 3, 1, "", "get_chunk"], [18, 2, 1, "", "host"], [18, 2, 1, "", "langchain_client"], [18, 2, 1, "", "port"], [18, 3, 1, "", "test_connection"]], "grag.components.vectordb.deeplake_client": [[18, 1, 1, "", "DeepLakeClient"]], "grag.components.vectordb.deeplake_client.DeepLakeClient": [[18, 3, 1, "", "aadd_docs"], [18, 3, 1, "", "add_docs"], [18, 3, 1, "", "aget_chunk"], [18, 2, 1, "", "client"], [18, 2, 1, "", "collection"], [18, 3, 1, "", "delete"], [18, 2, 1, "", "embedding_function"], [18, 2, 1, "", "embedding_model"], [18, 2, 1, "", "embedding_type"], [18, 3, 1, "", "get_chunk"], [18, 2, 1, "", "langchain_client"], [18, 2, 1, "", "store_path"]], "grag.quantize": [[20, 0, 0, "-", "quantize"], [20, 0, 0, "-", "utils"]], "grag.quantize.utils": [[20, 5, 1, "", "building_llamacpp"], [20, 5, 1, "", "fetch_model_repo"], [20, 5, 1, "", "get_llamacpp_repo"], [20, 5, 1, "", "quantize_model"]], "grag.rag": [[21, 0, 0, "-", "basic_rag"]], "grag.rag.basic_rag": [[21, 1, 1, "", "BasicRAG"]], "grag.rag.basic_rag.BasicRAG": [[21, 2, 1, "", "custom_prompt"], [21, 4, 1, "id0", "doc_chain"], [21, 2, 1, "", "llm_kwargs"], [21, 4, 1, "id1", "model_name"], [21, 3, 1, "", "output_parser"], [21, 3, 1, "", "prompt_matcher"], [21, 3, 1, "", "refine_call"], [21, 2, 1, "", "retriever_kwargs"], [21, 3, 1, "", "stuff_call"], [21, 3, 1, "", "stuff_docs"], [21, 4, 1, "id2", "task"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "method", "Python method"], "4": ["py", "property", "Python property"], "5": ["py", "function", "Python function"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:method", "4": "py:property", "5": "py:function"}, "terms": {"": 17, "0": [6, 8, 9, 17, 24], "00": [6, 9, 24], "000": [6, 9], "001": 24, "01": 24, "03": 24, "036": 24, "06": 24, "1": [8, 9, 17], "1024": 17, "12": 24, "13b": 17, "2": [2, 15, 17], "237": 24, "275": 24, "3": [8, 14, 17], "3f": 8, "400": [3, 4, 17], "484": 24, "5": [6, 24], "5000": 17, "6000": 17, "8000": [15, 18], "8c9040b0b5cd4d7cbc2e737da1b24ebf": 17, "935": 24, "A": [8, 17, 18, 20], "By": 15, "For": [12, 14, 15], "If": [14, 15, 17], "It": [17, 22], "OR": 15, "The": [8, 17, 18, 20, 22], "To": [11, 15], "__fields__": 17, "__file__": [2, 15], "__init__": 8, "__main__": [3, 4, 8], "__name__": [3, 4, 8], "_queri": 8, "_static": [3, 4], "_top_k": 8, "aadd_doc": [16, 17, 18], "abc": 18, "about": [8, 17], "abov": [14, 17], "abstract": 18, "accuraci": 17, "activ": 8, "add": [17, 18], "add_caption_first": [16, 17], "add_captions_to_block": [16, 17], "add_captions_to_text": [16, 17], "add_doc": [16, 17, 18], "addit": 17, "address": [8, 18], "after": [14, 17], "aget_chunk": [16, 17, 18], "aget_doc": [16, 17], "aingest": [2, 16, 17], "alik": 8, "aliv": 18, "all": [5, 7, 17, 18, 19, 24], "also": [17, 22], "alt": [3, 4], "altern": 2, "alwai": 17, "an": [7, 13, 14, 22], "ani": [15, 17, 22], "annot": 17, "answer": [0, 1], "anyth": 8, "api": 18, "app": 8, "appli": 20, "applic": 8, "ar": [12, 14, 15], "arg": 8, "argument": [15, 17, 21], "artifici": 8, "arxiv": 18, "async": [2, 17, 18], "asynchron": [2, 17, 18], "asyncio": 2, "attempt": 20, "attribut": 8, "augment": 22, "auth": 14, "auto": 17, "auto_exampl": [6, 9], "avail": 17, "awar": 17, "backend": 8, "bar": 18, "base": [0, 1, 8, 15, 16, 17, 21], "base_dir": 17, "basemodel": 17, "basi": 21, "basic": [0, 1, 6, 10, 16, 22, 23, 24], "basic_rag": [0, 1, 3, 4, 21], "basicrag": [0, 1, 3, 4, 16, 21, 23], "basicrag_customprompt": [0, 6, 24], "basicrag_fewshotprompt": [1, 6, 24], "basicrag_ingest": [2, 6, 24], "basicrag_refin": [3, 6, 24], "basicrag_stuff": [4, 6, 24], "batch": 17, "befor": 17, "being": 17, "below": [1, 5, 7], "better": 17, "block": 17, "blog": 8, "bool": [17, 18], "both": 15, "build": 20, "building_llamacpp": [16, 20, 23], "bulb": 8, "button": 8, "call": 17, "call_func": 21, "came": 1, "can": [12, 14, 15], "cannot": 17, "capstone_5": [17, 18], "caption": 17, "chain": [5, 6, 17, 21], "chang": [14, 15], "chat": 17, "check": [8, 14], "check_connect": 8, "chroma": [2, 8, 16, 17, 22], "chroma_cli": [2, 18], "chromacli": [2, 17, 18], "chromadb": 18, "chunk": [8, 17, 18], "chunk_overlap": [16, 17], "chunk_siz": [16, 17], "ci_test": 2, "class": [8, 17, 18, 21], "classifi": [16, 17], "classmethod": 17, "classvar": 17, "client": [2, 3, 4, 8, 15, 16, 17], "client_kwarg": 17, "clientserv": 15, "clone": [12, 14, 20], "cmake": 20, "co": 20, "code": [0, 1, 2, 3, 4, 5, 7, 8], "collect": [8, 17, 18], "collection_nam": [2, 3, 4, 8, 17, 18], "combin": 17, "command": 14, "complet": 13, "completedprocess": 20, "compon": [0, 1, 2, 3, 4, 8, 15, 16, 18, 22, 23], "comput": 17, "computedfieldinfo": 17, "concat": 17, "concaten": [17, 21], "config": [12, 14, 15, 17], "configdict": 17, "configpars": 17, "configur": 17, "conform": 17, "connect": [8, 17, 18], "contain": [15, 17, 19, 20], "content": 23, "context": [0, 1, 17], "convolut": 1, "cookbook": [0, 1, 2, 3, 4, 8, 15, 22, 24], "copi": [14, 20], "core": 18, "correspond": [17, 18], "cosin": [17, 18], "could": 8, "count": 8, "cpp": [14, 17, 20], "crucial": 15, "current": [15, 17], "current_path": 17, "custom": [5, 6, 12, 17], "custom_few_shot_prompt": 1, "custom_prompt": [0, 1, 16, 17, 21], "data": [2, 11, 17, 18], "databas": [2, 15, 17, 18], "decor": 21, "deeplak": [15, 16, 17, 22], "deeplake_cli": [2, 3, 4, 18], "deeplakecli": [2, 3, 4, 15, 17, 18], "def": 8, "default": [15, 17, 18, 20, 21], "defin": 17, "delet": [17, 18], "demonstr": [0, 1, 2, 3, 4, 5, 7, 8], "deriv": 18, "detail": [8, 14, 15, 17], "develop": 12, "devic": 17, "device_map": [16, 17], "dict": [17, 21], "dictionari": 17, "differ": 19, "dimension": 15, "dir_path": [2, 15, 17], "directori": [14, 17, 20], "displai": 8, "doc": [3, 4, 8, 17, 18, 21], "doc_chain": [0, 1, 3, 4, 16, 17, 21], "doc_id": 17, "document": [3, 4, 5, 6, 17, 18, 21], "doe": [14, 17], "download": [0, 1, 2, 3, 4, 5, 7, 8, 14, 20], "dry_run": 17, "dure": 17, "e": 12, "each": [17, 18], "easi": 22, "easiest": 14, "either": [14, 15], "element": 17, "elif": 2, "els": [8, 18], "embed": [8, 11, 16, 18, 23], "embedding_funct": [16, 17, 18], "embedding_model": [8, 15, 16, 17, 18], "embedding_modelnam": 18, "embedding_typ": [8, 15, 16, 17, 18], "en": 17, "end": [0, 1, 2, 3, 4, 8, 22], "ensur": 17, "enter": [8, 14], "enumer": 8, "etc": [14, 17], "exampl": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 14, 16, 17, 24], "example_templ": [1, 16, 17], "exclud": 17, "execut": [6, 9, 17, 24], "expand": 8, "explain": [], "explicitli": 15, "extract": 17, "extract_imag": [16, 17], "extract_image_block_typ": [16, 17], "f": 8, "f16": 17, "face": 17, "fals": [8, 17, 18], "fetch_model_repo": [16, 20, 23], "few": [5, 6, 17], "fewshotprompt": [1, 16, 17, 21, 23], "field": 17, "fieldinfo": 17, "figur": 17, "file": [6, 9, 12, 14, 15, 17, 20, 24], "filenotfounderror": 17, "filepath": [16, 17], "final": 14, "find": [8, 14, 17], "find_config_path": [16, 17, 23], "flexibl": 14, "float": [17, 18], "folder": 15, "follow": [0, 1, 14], "form": [8, 14], "form_submit_button": 8, "format": [16, 17, 21], "found": 17, "from": [0, 1, 2, 3, 4, 6, 8, 9, 12, 14, 17, 18, 20, 24], "full": [0, 1, 2, 3, 4, 8], "function": [8, 17, 18, 20], "further": 12, "galleri": [0, 1, 2, 3, 4, 5, 7, 8, 24], "gate": 14, "gen_doc_id": [16, 17], "gener": [0, 1, 2, 3, 4, 5, 7, 8, 15, 17, 22], "get": [14, 17, 22], "get_chunk": [8, 16, 17, 18], "get_config": [16, 17, 23], "get_doc": [16, 17], "get_docs_from_chunk": [16, 17], "get_llamacpp_repo": [16, 20, 23], "get_search_result": 8, "getcwd": 8, "gguf": 14, "git": [12, 20], "given": [0, 1, 17, 20], "glob": 17, "glob_pattern": 17, "go": [0, 1, 2, 3, 4, 8], "gpu": 17, "grag": [0, 1, 2, 3, 4, 8, 14, 17, 18, 20, 21], "green": 8, "gui": [9, 10, 22], "gui_jupyt": 7, "gui_python": 7, "ha": [14, 17], "handl": 17, "has_result": 8, "have": 12, "hexadecim": 17, "hf_pipelin": [16, 17], "hi_r": 17, "high": 15, "hkunlp": 18, "hold": 8, "home": [8, 17, 18], "host": [8, 15, 17, 18], "how": [0, 1, 2, 3, 4], "http": 8, "httpclient": 18, "hug": 17, "huggingfac": [11, 15, 17, 20], "i": [1, 5, 7, 8, 13, 14, 15, 17, 18, 20, 22], "id": [14, 17, 20], "id_gen": [16, 17], "id_kei": [16, 17], "identifi": 17, "imag": [3, 4, 17], "image_output_dir": [16, 17], "implement": [13, 22], "import": [0, 1, 2, 3, 4, 8], "includ": 17, "index": 22, "infer_table_structur": [16, 17], "ingest": [5, 6, 11, 16, 17], "ini": [12, 14, 15, 17], "initi": [8, 17], "input": [3, 4, 14, 17], "input_kei": [0, 1, 16, 17], "insert": 8, "instal": [11, 22], "instanc": [8, 17, 20], "instruct": 14, "instructor": [15, 17, 18], "int": [17, 18], "integ": 18, "integrag": 22, "intellig": 8, "interact": [8, 20], "interfac": 8, "introduc": 1, "io": 8, "ip": 18, "ipynb": [0, 1, 2, 3, 4, 8], "is_loc": 17, "its": 17, "join": [17, 21], "jpg": [3, 4], "json": 17, "jupit": 1, "jupyt": [0, 1, 2, 3, 4, 5, 7, 8], "just": 14, "k": 8, "kei": 17, "keyword": 21, "kwarg": [17, 21], "langchain": [17, 18], "langchain_cli": [17, 18], "langchain_commun": 18, "langchain_cor": [17, 21], "languag": [16, 17], "larg": 17, "largest": 1, "layer": 17, "lecun": 1, "len": 8, "level": 20, "like": [1, 8, 17, 22], "link": 17, "list": [8, 17, 18, 21], "llama": [14, 17, 20], "llama2": 17, "llama_cpp": [16, 17], "llamacpp": [11, 22], "llm": [11, 16, 19, 21, 22, 23], "llm_kwarg": [16, 21], "llm_type": [16, 17], "load": [16, 17], "load_env": 17, "load_fil": [16, 17], "load_model": [16, 17], "load_prompt": 17, "local": [14, 15, 17, 22], "localfilestor": 17, "localhost": 18, "locat": [17, 20], "look": 8, "lost": 8, "m": 14, "made": 12, "main": 8, "make": [14, 15, 20, 22], "manag": [8, 17], "map": 17, "markdown": 8, "match": 21, "max_new_token": [16, 17], "maximum": 17, "mb": [6, 9, 24], "mem": [6, 9, 24], "metadata": [8, 17], "metadata_toggl": 8, "method": 17, "min_valu": 8, "model": [8, 15, 17, 18, 20, 21], "model_computed_field": [16, 17], "model_config": [16, 17], "model_dir_path": 20, "model_field": [16, 17], "model_nam": [14, 16, 17, 21], "model_path": [16, 17], "model_typ": 17, "modul": [22, 23], "more": [14, 15, 17], "moreov": [], "most": [17, 18], "move": [15, 17], "much": 14, "multi": 17, "multi_vector": 17, "multivec_retriev": [2, 3, 4, 8, 17], "multivectorretriev": 17, "n": [8, 17], "n_batch": [16, 17], "n_ctx": [16, 17], "n_gpu_lay": [16, 17], "name": [1, 8, 14, 16, 17, 18, 21], "namespac": [16, 17], "network": 1, "neural": 1, "new": 17, "new_pap": 2, "nn": [17, 21], "non": 15, "none": [17, 18, 20, 21], "nonetyp": 17, "nosourc": 17, "note": 14, "notebook": [0, 1, 2, 3, 4, 5, 7, 8], "number": [8, 17, 18], "number_input": 8, "o": 8, "object": [17, 21], "offer": [14, 22], "one_to_on": 17, "onlin": 14, "open": 13, "oper": 20, "option": [8, 17, 20], "orchestr": 8, "otherwis": 8, "our": 15, "output": [17, 18, 21], "output_dir": 20, "output_kei": [1, 16, 17], "output_pars": [16, 21], "overlap": 17, "overwrit": 17, "packag": 22, "page": [8, 17, 21, 22], "page_cont": 8, "pagehom": 8, "pair": 17, "paramet": [8, 17, 18, 20, 21], "parent": [2, 8, 15, 17], "pars": [16, 23], "parse_pdf": 17, "parsepdf": [16, 17, 23], "parser": 17, "parser_kwarg": 17, "partit": [16, 17], "pass": 17, "path": [2, 8, 14, 15, 17, 18, 20], "pathlib": [2, 8], "pattern": 17, "pdf": [2, 15, 16, 23], "phase": 12, "pip": 12, "pipelin": 17, "place": 17, "planet": 1, "point": 17, "port": [8, 15, 17, 18], "prefix": [1, 16, 17], "print": 18, "priorit": 17, "process": [3, 4, 15, 17], "process_imag": [16, 17], "process_t": [16, 17], "process_text": [16, 17], "produc": 17, "progress": [17, 18], "project": 20, "prompt": [5, 6, 14, 16, 21, 22, 23], "prompt_match": [16, 21], "prompttempl": 17, "properti": [17, 21], "provid": [13, 14, 15, 17, 18, 19, 21, 22], "publish": 12, "pull": 20, "py": [0, 1, 2, 3, 4, 6, 8, 9, 24], "pydant": 17, "pypi": 12, "python": [0, 1, 2, 3, 4, 5, 7, 8, 14, 22], "q4_k_m": 14, "q5_k_m": [14, 17], "qa": [17, 21], "quantiz": [16, 17, 22, 23], "quantize_model": [16, 20, 23], "queri": [3, 4, 8, 17, 18], "question": [0, 1], "rag": [0, 1, 3, 4, 6, 10, 15, 16, 22, 23, 24], "rag_jupyt": 5, "rag_python": 5, "rais": 17, "random": 18, "reach": 17, "read": 17, "read_onli": 18, "recommend": 14, "recurs": 17, "red": 8, "refer": [15, 17], "refin": [5, 6, 17, 21], "refine_cal": [16, 21], "refine_chain_langchain_illustr": 3, "relvant": 21, "render": 8, "render_search_form": 8, "render_search_result": 8, "render_sidebar": 8, "render_stat": 8, "replac": 17, "repo": 14, "repo_id": 20, "repositori": [12, 14, 20], "repr": 17, "repres": 8, "requir": [14, 17], "respect": 17, "respons": 8, "result": [8, 20], "retriev": [2, 3, 4, 9, 10, 15, 16, 21, 22, 23], "retriever_app": [8, 9], "retriever_kwarg": [16, 21], "retriv": [7, 9], "return": [8, 17, 18, 20, 21], "root": [17, 20], "root_path": 20, "run": [2, 11, 15, 22], "run_chroma": 15, "same": 17, "sampl": 17, "save": [16, 17, 20], "score": [8, 17, 18], "script": [15, 17], "search": [8, 17, 22], "search_form": 8, "self": [8, 17, 18], "semant": 8, "sentenc": [17, 18], "seper": [17, 21], "server": 15, "session_st": 8, "set": [8, 14, 17], "sh": 15, "shot": [5, 6, 17], "should": [14, 17, 18, 20], "show": [8, 17, 18], "sidebar": 8, "similar": [8, 17, 18], "similiar": 8, "simpl": [7, 8, 22], "sinc": [12, 15], "singl": [17, 18], "single_text_out": [16, 17], "size": 17, "slow": 2, "smaller": 17, "so": 17, "solut": 22, "sourc": [0, 1, 2, 3, 4, 5, 7, 8, 13, 15, 16, 17, 18, 20, 21], "specifi": [17, 20], "sphinx": [0, 1, 2, 3, 4, 5, 7, 8], "sphx_glr_auto_examples_basicrag_customprompt": 24, "sphx_glr_auto_examples_basicrag_fewshotprompt": 24, "sphx_glr_auto_examples_basicrag_ingest": 24, "sphx_glr_auto_examples_basicrag_refin": 24, "sphx_glr_auto_examples_basicrag_stuff": 24, "spinner": 8, "split": 17, "split_doc": [16, 17], "splitter": [16, 23], "src": [3, 4, 12, 15], "st": 8, "start": [14, 17, 22], "state": 8, "static": 21, "statist": 8, "statu": 18, "std_out": 17, "step": 8, "storag": 17, "store": [11, 16, 17, 18, 22], "store_path": [16, 17, 18], "str": [8, 17, 18, 20, 21], "strategi": [16, 17], "streamlit": [7, 8], "stremlit": 8, "string": [17, 18, 21], "stuff": [0, 1, 5, 6, 17, 21], "stuff_cal": [16, 21], "stuff_chain_langchain_illustr": 4, "stuff_doc": [16, 17, 21, 23], "submit": 8, "submodul": [16, 17, 23], "subprocess": 20, "suffix": [1, 16, 17], "support": [11, 17, 18, 22], "sure": [14, 15], "sy": 8, "sync": 2, "synchron": 2, "system": 8, "tab": 8, "tab1": 8, "tab2": 8, "tabl": 17, "table_as_html": 17, "take": 17, "task": [16, 17, 21], "temperatur": [16, 17], "templat": [0, 16, 17], "test": [2, 3, 4, 18], "test_connect": [8, 17, 18], "text": [16, 23], "text_concat": [16, 17], "text_input": 8, "text_splitt": [16, 17], "textsplitt": [16, 17, 23], "thank": 22, "them": 17, "thi": [0, 1, 2, 3, 4, 8, 14, 15, 17, 18, 21], "time": 17, "titl": 8, "toggl": 8, "token": [14, 17], "top": [8, 17, 18], "top_k": [8, 16, 17, 18], "total": [6, 9, 24], "transform": [17, 18], "travers": 17, "tree": 17, "true": [2, 3, 4, 8, 17, 18], "tupl": 18, "two": 14, "type": [8, 15, 17, 18, 21], "typic": 17, "ubuntu": [17, 18], "ui": 8, "under": 15, "union": 17, "uniqu": 17, "until": 17, "up": [1, 8, 17], "updat": 20, "us": [0, 1, 2, 3, 4, 5, 7, 8, 11, 15, 17, 18, 20, 21], "user": 14, "util": [16, 23], "uuid": 17, "uuid5": 17, "v": 17, "v1": 17, "valid": 17, "validate_doc_chain": [16, 17], "validate_exampl": [16, 17], "validate_input_kei": [16, 17], "validate_output_kei": [16, 17], "validate_task": [16, 17], "valu": [8, 17], "valueerror": 17, "variou": 22, "vector": [2, 11, 17, 18, 22], "vectordb": [2, 3, 4, 8, 15, 16, 23], "vectorstor": [15, 18], "verbos": [17, 18], "volume_2k": [17, 18], "wai": [14, 22], "want": 14, "we": 12, "web": 8, "what": [1, 8], "where": [14, 20], "whether": 17, "which": 17, "while": [3, 4], "who": 1, "width": [3, 4], "with_scor": [8, 17, 18], "wrapper": 18, "write": 8, "xl": [15, 18], "yann": 1, "yet": 12, "you": 14, "your": 8, "your_collection_nam": 2, "zip": [5, 7]}, "titles": ["Custom Prompts", "Custom Few-Shot Prompts", "Document Ingestion", "Refine Chain", "Stuff Chain", "Basic-RAG Cookbooks", "Computation times", "Retriever-GUI Cookbooks", "Retriever GUI", "Computation times", "Cookbooks", "Get Started", "Installation", "GRAG Overview", "LLMs", "Vector Stores", "GRAG", "Components", "VectorDB", "Prompts", "Quantize", "RAG", "Welcome to GRAG\u2019s documentation!", "grag", "Computation times"], "titleterms": {"": 22, "To": 14, "augment": 13, "base": 18, "basic": [5, 21], "chain": [3, 4], "chroma": [15, 18], "client": 18, "compon": 17, "comput": [6, 9, 24], "content": [16, 17, 18, 19, 20, 21, 22], "cookbook": [5, 7, 10], "custom": [0, 1], "data": 15, "deeplak": 18, "document": [2, 22], "embed": [15, 17], "few": 1, "gener": 13, "get": 11, "grag": [13, 16, 22, 23], "gui": [7, 8], "how": 14, "huggingfac": 14, "indic": 22, "ingest": [2, 15], "instal": 12, "llamacpp": 14, "llm": [14, 17], "model": 14, "modul": [16, 17, 18, 19, 20, 21], "overview": 13, "pars": 17, "pdf": 17, "prompt": [0, 1, 17, 19], "quantiz": [14, 20], "rag": [5, 21], "refin": 3, "retriev": [7, 8, 13, 17], "run": 14, "shot": 1, "splitter": 17, "start": 11, "store": 15, "stuff": 4, "submodul": [18, 20, 21], "support": 15, "tabl": 22, "text": 17, "time": [6, 9, 24], "us": 14, "util": [17, 20], "vector": 15, "vectordb": [17, 18], "welcom": 22}}) \ No newline at end of file +Search.setIndex({"alltitles": {"Base": [[18, "module-grag.components.vectordb.base"]], "Basic RAG": [[21, "module-grag.rag.basic_rag"]], "Basic-RAG Cookbooks": [[5, "basic-rag-cookbooks"]], "Chroma": [[15, "chroma"]], "Chroma Client": [[18, "module-grag.components.vectordb.chroma_client"]], "Components": [[17, "components"]], "Computation times": [[6, "computation-times"], [9, "computation-times"], [24, "computation-times"]], "Contents:": [[22, null]], "Cookbooks": [[10, "cookbooks"]], "Custom Few-Shot Prompts": [[1, "custom-few-shot-prompts"]], "Custom Prompts": [[0, "custom-prompts"]], "Data Ingestion": [[15, "data-ingestion"]], "Deeplake Client": [[18, "module-grag.components.vectordb.deeplake_client"]], "Document Ingestion": [[2, "document-ingestion"]], "Embedding": [[17, "module-grag.components.embedding"]], "Embeddings": [[15, "embeddings"]], "GRAG": [[16, "grag"]], "GRAG Overview": [[13, "grag-overview"]], "Get Started": [[11, "get-started"]], "How to quantize models.": [[14, "how-to-quantize-models"]], "Indices and tables": [[22, "indices-and-tables"]], "Installation": [[12, "installation"]], "LLM": [[17, "module-grag.components.llm"]], "Module Contents": [[18, "module-grag.components.vectordb"]], "Module contents": [[16, "module-grag"], [17, "module-grag.components"], [19, "module-grag.prompts"], [20, "module-grag.quantize"], [21, "module-grag.rag"]], "Parse PDF": [[17, "module-grag.components.parse_pdf"]], "Prompt": [[17, "module-grag.components.prompt"]], "Prompts": [[19, "prompts"]], "Quantize": [[20, "quantize"], [20, "id1"]], "RAG": [[21, "rag"]], "Refine Chain": [[3, "refine-chain"]], "Retrieval-Augmented Generation": [[13, "retrieval-augmented-generation"]], "Retriever": [[17, "module-grag.components.multivec_retriever"]], "Retriever GUI": [[8, "retriever-gui"]], "Retriever-GUI Cookbooks": [[7, "retriever-gui-cookbooks"]], "Stuff Chain": [[4, "stuff-chain"]], "Submodules": [[18, "submodules"], [20, "submodules"], [21, "submodules"]], "Supported Vector Stores": [[15, "supported-vector-stores"]], "Text Splitter": [[17, "module-grag.components.text_splitter"]], "To run LLMs using HuggingFace": [[14, "to-run-llms-using-huggingface"]], "To run LLMs using LlamaCPP": [[14, "to-run-llms-using-llamacpp"]], "Utils": [[17, "module-grag.components.utils"], [20, "module-grag.quantize.utils"]], "Vector Stores": [[15, "vector-stores"]], "VectorDB": [[17, "vectordb"], [18, "vectordb"]], "Welcome to GRAG\u2019s documentation!": [[22, "welcome-to-grag-s-documentation"]], "grag": [[23, "grag"]]}, "docnames": ["auto_examples/Basic-RAG/BasicRAG_CustomPrompt", "auto_examples/Basic-RAG/BasicRAG_FewShotPrompt", "auto_examples/Basic-RAG/BasicRAG_ingest", "auto_examples/Basic-RAG/BasicRAG_refine", "auto_examples/Basic-RAG/BasicRAG_stuff", "auto_examples/Basic-RAG/index", "auto_examples/Basic-RAG/sg_execution_times", "auto_examples/Retriver-GUI/index", "auto_examples/Retriver-GUI/retriever_app", "auto_examples/Retriver-GUI/sg_execution_times", "auto_examples_index", "get_started", "get_started.installation", "get_started.introduction", "get_started.llms", "get_started.vectordb", "grag", "grag.components", "grag.components.vectordb", "grag.prompts", "grag.quantize", "grag.rag", "index", "modules", "sg_execution_times"], "envversion": {"sphinx": 61, "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.todo": 2}, "filenames": ["auto_examples/Basic-RAG/BasicRAG_CustomPrompt.rst", "auto_examples/Basic-RAG/BasicRAG_FewShotPrompt.rst", "auto_examples/Basic-RAG/BasicRAG_ingest.rst", "auto_examples/Basic-RAG/BasicRAG_refine.rst", "auto_examples/Basic-RAG/BasicRAG_stuff.rst", "auto_examples/Basic-RAG/index.rst", "auto_examples/Basic-RAG/sg_execution_times.rst", "auto_examples/Retriver-GUI/index.rst", "auto_examples/Retriver-GUI/retriever_app.rst", "auto_examples/Retriver-GUI/sg_execution_times.rst", "auto_examples_index.rst", "get_started.rst", "get_started.installation.rst", "get_started.introduction.rst", "get_started.llms.rst", "get_started.vectordb.rst", "grag.rst", "grag.components.rst", "grag.components.vectordb.rst", "grag.prompts.rst", "grag.quantize.rst", "grag.rag.rst", "index.rst", "modules.rst", "sg_execution_times.rst"], "indexentries": {"aadd_docs() (grag.components.multivec_retriever.retriever method)": [[17, "grag.components.multivec_retriever.Retriever.aadd_docs", false]], "aadd_docs() (grag.components.vectordb.base.vectordb method)": [[18, "grag.components.vectordb.base.VectorDB.aadd_docs", false]], "aadd_docs() (grag.components.vectordb.chroma_client.chromaclient method)": [[18, "grag.components.vectordb.chroma_client.ChromaClient.aadd_docs", false]], "aadd_docs() (grag.components.vectordb.deeplake_client.deeplakeclient method)": [[18, "grag.components.vectordb.deeplake_client.DeepLakeClient.aadd_docs", false]], "add_caption_first (grag.components.parse_pdf.parsepdf attribute)": [[17, "grag.components.parse_pdf.ParsePDF.add_caption_first", false]], "add_captions_to_blocks (grag.components.parse_pdf.parsepdf attribute)": [[17, "grag.components.parse_pdf.ParsePDF.add_captions_to_blocks", false]], "add_captions_to_text (grag.components.parse_pdf.parsepdf attribute)": [[17, "grag.components.parse_pdf.ParsePDF.add_captions_to_text", false]], "add_docs() (grag.components.multivec_retriever.retriever method)": [[17, "grag.components.multivec_retriever.Retriever.add_docs", false]], "add_docs() (grag.components.vectordb.base.vectordb method)": [[18, "grag.components.vectordb.base.VectorDB.add_docs", false]], "add_docs() (grag.components.vectordb.chroma_client.chromaclient method)": [[18, "grag.components.vectordb.chroma_client.ChromaClient.add_docs", false]], "add_docs() (grag.components.vectordb.deeplake_client.deeplakeclient method)": [[18, "grag.components.vectordb.deeplake_client.DeepLakeClient.add_docs", false]], "aget_chunk() (grag.components.multivec_retriever.retriever method)": [[17, "grag.components.multivec_retriever.Retriever.aget_chunk", false]], "aget_chunk() (grag.components.vectordb.base.vectordb method)": [[18, "grag.components.vectordb.base.VectorDB.aget_chunk", false]], "aget_chunk() (grag.components.vectordb.chroma_client.chromaclient method)": [[18, "grag.components.vectordb.chroma_client.ChromaClient.aget_chunk", false]], "aget_chunk() (grag.components.vectordb.deeplake_client.deeplakeclient method)": [[18, "grag.components.vectordb.deeplake_client.DeepLakeClient.aget_chunk", false]], "aget_doc() (grag.components.multivec_retriever.retriever method)": [[17, "grag.components.multivec_retriever.Retriever.aget_doc", false]], "aingest() (grag.components.multivec_retriever.retriever method)": [[17, "grag.components.multivec_retriever.Retriever.aingest", false]], "basicrag (class in grag.rag.basic_rag)": [[21, "grag.rag.basic_rag.BasicRAG", false]], "building_llamacpp() (in module grag.quantize.utils)": [[20, "grag.quantize.utils.building_llamacpp", false]], "chromaclient (class in grag.components.vectordb.chroma_client)": [[18, "grag.components.vectordb.chroma_client.ChromaClient", false]], "chunk_overlap (grag.components.text_splitter.textsplitter attribute)": [[17, "grag.components.text_splitter.TextSplitter.chunk_overlap", false]], "chunk_size (grag.components.text_splitter.textsplitter attribute)": [[17, "grag.components.text_splitter.TextSplitter.chunk_size", false]], "classify() (grag.components.parse_pdf.parsepdf method)": [[17, "grag.components.parse_pdf.ParsePDF.classify", false]], "client (grag.components.vectordb.chroma_client.chromaclient attribute)": [[18, "grag.components.vectordb.chroma_client.ChromaClient.client", false]], "client (grag.components.vectordb.deeplake_client.deeplakeclient attribute)": [[18, "grag.components.vectordb.deeplake_client.DeepLakeClient.client", false]], "collection (grag.components.vectordb.chroma_client.chromaclient attribute)": [[18, "grag.components.vectordb.chroma_client.ChromaClient.collection", false]], "collection (grag.components.vectordb.deeplake_client.deeplakeclient attribute)": [[18, "grag.components.vectordb.deeplake_client.DeepLakeClient.collection", false]], "collection_name (grag.components.vectordb.chroma_client.chromaclient attribute)": [[18, "grag.components.vectordb.chroma_client.ChromaClient.collection_name", false]], "custom_prompt (grag.rag.basic_rag.basicrag attribute)": [[21, "grag.rag.basic_rag.BasicRAG.custom_prompt", false]], "deeplakeclient (class in grag.components.vectordb.deeplake_client)": [[18, "grag.components.vectordb.deeplake_client.DeepLakeClient", false]], "delete() (grag.components.vectordb.base.vectordb method)": [[18, "grag.components.vectordb.base.VectorDB.delete", false]], "delete() (grag.components.vectordb.chroma_client.chromaclient method)": [[18, "grag.components.vectordb.chroma_client.ChromaClient.delete", false]], "delete() (grag.components.vectordb.deeplake_client.deeplakeclient method)": [[18, "grag.components.vectordb.deeplake_client.DeepLakeClient.delete", false]], "device_map (grag.components.llm.llm attribute)": [[17, "grag.components.llm.LLM.device_map", false]], "doc_chain (grag.components.prompt.fewshotprompt attribute)": [[17, "grag.components.prompt.FewShotPrompt.doc_chain", false]], "doc_chain (grag.components.prompt.prompt attribute)": [[17, "grag.components.prompt.Prompt.doc_chain", false], [17, "id6", false]], "doc_chain (grag.rag.basic_rag.basicrag attribute)": [[21, "grag.rag.basic_rag.BasicRAG.doc_chain", false]], "doc_chain (grag.rag.basic_rag.basicrag property)": [[21, "id0", false]], "embedding (class in grag.components.embedding)": [[17, "grag.components.embedding.Embedding", false]], "embedding_function (grag.components.embedding.embedding attribute)": [[17, "grag.components.embedding.Embedding.embedding_function", false]], "embedding_function (grag.components.vectordb.chroma_client.chromaclient attribute)": [[18, "grag.components.vectordb.chroma_client.ChromaClient.embedding_function", false]], "embedding_function (grag.components.vectordb.deeplake_client.deeplakeclient attribute)": [[18, "grag.components.vectordb.deeplake_client.DeepLakeClient.embedding_function", false]], "embedding_model (grag.components.embedding.embedding attribute)": [[17, "grag.components.embedding.Embedding.embedding_model", false]], "embedding_model (grag.components.vectordb.chroma_client.chromaclient attribute)": [[18, "grag.components.vectordb.chroma_client.ChromaClient.embedding_model", false]], "embedding_model (grag.components.vectordb.deeplake_client.deeplakeclient attribute)": [[18, "grag.components.vectordb.deeplake_client.DeepLakeClient.embedding_model", false]], "embedding_type (grag.components.embedding.embedding attribute)": [[17, "grag.components.embedding.Embedding.embedding_type", false]], "embedding_type (grag.components.vectordb.chroma_client.chromaclient attribute)": [[18, "grag.components.vectordb.chroma_client.ChromaClient.embedding_type", false]], "embedding_type (grag.components.vectordb.deeplake_client.deeplakeclient attribute)": [[18, "grag.components.vectordb.deeplake_client.DeepLakeClient.embedding_type", false]], "example_template (grag.components.prompt.fewshotprompt attribute)": [[17, "grag.components.prompt.FewShotPrompt.example_template", false], [17, "id2", false]], "examples (grag.components.prompt.fewshotprompt attribute)": [[17, "grag.components.prompt.FewShotPrompt.examples", false], [17, "id3", false]], "extract_image_block_types (grag.components.parse_pdf.parsepdf attribute)": [[17, "grag.components.parse_pdf.ParsePDF.extract_image_block_types", false]], "extract_images (grag.components.parse_pdf.parsepdf attribute)": [[17, "grag.components.parse_pdf.ParsePDF.extract_images", false]], "fetch_model_repo() (in module grag.quantize.utils)": [[20, "grag.quantize.utils.fetch_model_repo", false]], "fewshotprompt (class in grag.components.prompt)": [[17, "grag.components.prompt.FewShotPrompt", false]], "filepath (grag.components.prompt.fewshotprompt attribute)": [[17, "grag.components.prompt.FewShotPrompt.filepath", false]], "filepath (grag.components.prompt.prompt attribute)": [[17, "grag.components.prompt.Prompt.filepath", false], [17, "id7", false]], "find_config_path() (in module grag.components.utils)": [[17, "grag.components.utils.find_config_path", false]], "format() (grag.components.prompt.prompt method)": [[17, "grag.components.prompt.Prompt.format", false]], "gen_doc_ids() (grag.components.multivec_retriever.retriever method)": [[17, "grag.components.multivec_retriever.Retriever.gen_doc_ids", false]], "get_chunk() (grag.components.multivec_retriever.retriever method)": [[17, "grag.components.multivec_retriever.Retriever.get_chunk", false]], "get_chunk() (grag.components.vectordb.base.vectordb method)": [[18, "grag.components.vectordb.base.VectorDB.get_chunk", false]], "get_chunk() (grag.components.vectordb.chroma_client.chromaclient method)": [[18, "grag.components.vectordb.chroma_client.ChromaClient.get_chunk", false]], "get_chunk() (grag.components.vectordb.deeplake_client.deeplakeclient method)": [[18, "grag.components.vectordb.deeplake_client.DeepLakeClient.get_chunk", false]], "get_config() (in module grag.components.utils)": [[17, "grag.components.utils.get_config", false]], "get_doc() (grag.components.multivec_retriever.retriever method)": [[17, "grag.components.multivec_retriever.Retriever.get_doc", false]], "get_docs_from_chunks() (grag.components.multivec_retriever.retriever method)": [[17, "grag.components.multivec_retriever.Retriever.get_docs_from_chunks", false]], "get_llamacpp_repo() (in module grag.quantize.utils)": [[20, "grag.quantize.utils.get_llamacpp_repo", false]], "grag": [[16, "module-grag", false]], "grag.components": [[17, "module-grag.components", false]], "grag.components.embedding": [[17, "module-grag.components.embedding", false]], "grag.components.llm": [[17, "module-grag.components.llm", false]], "grag.components.multivec_retriever": [[17, "module-grag.components.multivec_retriever", false]], "grag.components.parse_pdf": [[17, "module-grag.components.parse_pdf", false]], "grag.components.prompt": [[17, "module-grag.components.prompt", false]], "grag.components.text_splitter": [[17, "module-grag.components.text_splitter", false]], "grag.components.utils": [[17, "module-grag.components.utils", false]], "grag.components.vectordb": [[18, "module-grag.components.vectordb", false]], "grag.components.vectordb.base": [[18, "module-grag.components.vectordb.base", false]], "grag.components.vectordb.chroma_client": [[18, "module-grag.components.vectordb.chroma_client", false]], "grag.components.vectordb.deeplake_client": [[18, "module-grag.components.vectordb.deeplake_client", false]], "grag.prompts": [[19, "module-grag.prompts", false]], "grag.quantize": [[20, "module-grag.quantize", false]], "grag.quantize.quantize": [[20, "module-grag.quantize.quantize", false]], "grag.quantize.utils": [[20, "module-grag.quantize.utils", false]], "grag.rag": [[21, "module-grag.rag", false]], "grag.rag.basic_rag": [[21, "module-grag.rag.basic_rag", false]], "hf_pipeline() (grag.components.llm.llm method)": [[17, "grag.components.llm.LLM.hf_pipeline", false]], "host (grag.components.vectordb.chroma_client.chromaclient attribute)": [[18, "grag.components.vectordb.chroma_client.ChromaClient.host", false]], "id_gen() (grag.components.multivec_retriever.retriever method)": [[17, "grag.components.multivec_retriever.Retriever.id_gen", false]], "id_key (grag.components.multivec_retriever.retriever attribute)": [[17, "grag.components.multivec_retriever.Retriever.id_key", false]], "image_output_dir (grag.components.parse_pdf.parsepdf attribute)": [[17, "grag.components.parse_pdf.ParsePDF.image_output_dir", false]], "infer_table_structure (grag.components.parse_pdf.parsepdf attribute)": [[17, "grag.components.parse_pdf.ParsePDF.infer_table_structure", false]], "ingest() (grag.components.multivec_retriever.retriever method)": [[17, "grag.components.multivec_retriever.Retriever.ingest", false]], "input_keys (grag.components.prompt.fewshotprompt attribute)": [[17, "grag.components.prompt.FewShotPrompt.input_keys", false], [17, "id1", false]], "input_keys (grag.components.prompt.prompt attribute)": [[17, "grag.components.prompt.Prompt.input_keys", false], [17, "id8", false]], "langchain_client (grag.components.vectordb.chroma_client.chromaclient attribute)": [[18, "grag.components.vectordb.chroma_client.ChromaClient.langchain_client", false]], "langchain_client (grag.components.vectordb.deeplake_client.deeplakeclient attribute)": [[18, "grag.components.vectordb.deeplake_client.DeepLakeClient.langchain_client", false]], "language (grag.components.prompt.fewshotprompt attribute)": [[17, "grag.components.prompt.FewShotPrompt.language", false]], "language (grag.components.prompt.prompt attribute)": [[17, "grag.components.prompt.Prompt.language", false], [17, "id9", false]], "llama_cpp() (grag.components.llm.llm method)": [[17, "grag.components.llm.LLM.llama_cpp", false]], "llm (class in grag.components.llm)": [[17, "grag.components.llm.LLM", false]], "llm_kwargs (grag.rag.basic_rag.basicrag attribute)": [[21, "grag.rag.basic_rag.BasicRAG.llm_kwargs", false]], "llm_type (grag.components.prompt.fewshotprompt attribute)": [[17, "grag.components.prompt.FewShotPrompt.llm_type", false]], "llm_type (grag.components.prompt.prompt attribute)": [[17, "grag.components.prompt.Prompt.llm_type", false], [17, "id10", false]], "load() (grag.components.prompt.prompt class method)": [[17, "grag.components.prompt.Prompt.load", false]], "load_file() (grag.components.parse_pdf.parsepdf method)": [[17, "grag.components.parse_pdf.ParsePDF.load_file", false]], "load_model() (grag.components.llm.llm method)": [[17, "grag.components.llm.LLM.load_model", false]], "max_new_tokens (grag.components.llm.llm attribute)": [[17, "grag.components.llm.LLM.max_new_tokens", false]], "model_computed_fields (grag.components.prompt.fewshotprompt attribute)": [[17, "grag.components.prompt.FewShotPrompt.model_computed_fields", false]], "model_computed_fields (grag.components.prompt.prompt attribute)": [[17, "grag.components.prompt.Prompt.model_computed_fields", false]], "model_config (grag.components.prompt.fewshotprompt attribute)": [[17, "grag.components.prompt.FewShotPrompt.model_config", false]], "model_config (grag.components.prompt.prompt attribute)": [[17, "grag.components.prompt.Prompt.model_config", false]], "model_fields (grag.components.prompt.fewshotprompt attribute)": [[17, "grag.components.prompt.FewShotPrompt.model_fields", false]], "model_fields (grag.components.prompt.prompt attribute)": [[17, "grag.components.prompt.Prompt.model_fields", false]], "model_name (grag.components.llm.llm attribute)": [[17, "grag.components.llm.LLM.model_name", false]], "model_name (grag.components.llm.llm property)": [[17, "id0", false]], "model_name (grag.rag.basic_rag.basicrag attribute)": [[21, "grag.rag.basic_rag.BasicRAG.model_name", false]], "model_name (grag.rag.basic_rag.basicrag property)": [[21, "id1", false]], "model_path (grag.components.llm.llm property)": [[17, "grag.components.llm.LLM.model_path", false]], "module": [[16, "module-grag", false], [17, "module-grag.components", false], [17, "module-grag.components.embedding", false], [17, "module-grag.components.llm", false], [17, "module-grag.components.multivec_retriever", false], [17, "module-grag.components.parse_pdf", false], [17, "module-grag.components.prompt", false], [17, "module-grag.components.text_splitter", false], [17, "module-grag.components.utils", false], [18, "module-grag.components.vectordb", false], [18, "module-grag.components.vectordb.base", false], [18, "module-grag.components.vectordb.chroma_client", false], [18, "module-grag.components.vectordb.deeplake_client", false], [19, "module-grag.prompts", false], [20, "module-grag.quantize", false], [20, "module-grag.quantize.quantize", false], [20, "module-grag.quantize.utils", false], [21, "module-grag.rag", false], [21, "module-grag.rag.basic_rag", false]], "n_batch (grag.components.llm.llm attribute)": [[17, "grag.components.llm.LLM.n_batch", false]], "n_ctx (grag.components.llm.llm attribute)": [[17, "grag.components.llm.LLM.n_ctx", false]], "n_gpu_layers (grag.components.llm.llm attribute)": [[17, "grag.components.llm.LLM.n_gpu_layers", false]], "name (grag.components.prompt.fewshotprompt attribute)": [[17, "grag.components.prompt.FewShotPrompt.name", false]], "name (grag.components.prompt.prompt attribute)": [[17, "grag.components.prompt.Prompt.name", false], [17, "id11", false]], "namespace (grag.components.multivec_retriever.retriever attribute)": [[17, "grag.components.multivec_retriever.Retriever.namespace", false]], "output_keys (grag.components.prompt.fewshotprompt attribute)": [[17, "grag.components.prompt.FewShotPrompt.output_keys", false]], "output_parser() (grag.rag.basic_rag.basicrag static method)": [[21, "grag.rag.basic_rag.BasicRAG.output_parser", false]], "parsepdf (class in grag.components.parse_pdf)": [[17, "grag.components.parse_pdf.ParsePDF", false]], "partition() (grag.components.parse_pdf.parsepdf method)": [[17, "grag.components.parse_pdf.ParsePDF.partition", false]], "port (grag.components.vectordb.chroma_client.chromaclient attribute)": [[18, "grag.components.vectordb.chroma_client.ChromaClient.port", false]], "prefix (grag.components.prompt.fewshotprompt attribute)": [[17, "grag.components.prompt.FewShotPrompt.prefix", false], [17, "id4", false]], "process_images() (grag.components.parse_pdf.parsepdf method)": [[17, "grag.components.parse_pdf.ParsePDF.process_images", false]], "process_tables() (grag.components.parse_pdf.parsepdf method)": [[17, "grag.components.parse_pdf.ParsePDF.process_tables", false]], "process_text() (grag.components.parse_pdf.parsepdf method)": [[17, "grag.components.parse_pdf.ParsePDF.process_text", false]], "prompt (class in grag.components.prompt)": [[17, "grag.components.prompt.Prompt", false]], "prompt (grag.components.prompt.prompt attribute)": [[17, "grag.components.prompt.Prompt.prompt", false]], "prompt_matcher() (grag.rag.basic_rag.basicrag method)": [[21, "grag.rag.basic_rag.BasicRAG.prompt_matcher", false]], "quantize_model() (in module grag.quantize.utils)": [[20, "grag.quantize.utils.quantize_model", false]], "refine_call() (grag.rag.basic_rag.basicrag method)": [[21, "grag.rag.basic_rag.BasicRAG.refine_call", false]], "retriever (class in grag.components.multivec_retriever)": [[17, "grag.components.multivec_retriever.Retriever", false]], "retriever (grag.components.multivec_retriever.retriever attribute)": [[17, "grag.components.multivec_retriever.Retriever.retriever", false]], "retriever_kwargs (grag.rag.basic_rag.basicrag attribute)": [[21, "grag.rag.basic_rag.BasicRAG.retriever_kwargs", false]], "save() (grag.components.prompt.prompt method)": [[17, "grag.components.prompt.Prompt.save", false]], "single_text_out (grag.components.parse_pdf.parsepdf attribute)": [[17, "grag.components.parse_pdf.ParsePDF.single_text_out", false]], "source (grag.components.prompt.fewshotprompt attribute)": [[17, "grag.components.prompt.FewShotPrompt.source", false]], "source (grag.components.prompt.prompt attribute)": [[17, "grag.components.prompt.Prompt.source", false], [17, "id12", false]], "split_docs() (grag.components.multivec_retriever.retriever method)": [[17, "grag.components.multivec_retriever.Retriever.split_docs", false]], "splitter (grag.components.multivec_retriever.retriever attribute)": [[17, "grag.components.multivec_retriever.Retriever.splitter", false]], "store (grag.components.multivec_retriever.retriever attribute)": [[17, "grag.components.multivec_retriever.Retriever.store", false]], "store_path (grag.components.multivec_retriever.retriever attribute)": [[17, "grag.components.multivec_retriever.Retriever.store_path", false]], "store_path (grag.components.vectordb.deeplake_client.deeplakeclient attribute)": [[18, "grag.components.vectordb.deeplake_client.DeepLakeClient.store_path", false]], "strategy (grag.components.parse_pdf.parsepdf attribute)": [[17, "grag.components.parse_pdf.ParsePDF.strategy", false]], "stuff_call() (grag.rag.basic_rag.basicrag method)": [[21, "grag.rag.basic_rag.BasicRAG.stuff_call", false]], "stuff_docs() (grag.rag.basic_rag.basicrag static method)": [[21, "grag.rag.basic_rag.BasicRAG.stuff_docs", false]], "stuff_docs() (in module grag.components.utils)": [[17, "grag.components.utils.stuff_docs", false]], "suffix (grag.components.prompt.fewshotprompt attribute)": [[17, "grag.components.prompt.FewShotPrompt.suffix", false], [17, "id5", false]], "task (grag.components.llm.llm attribute)": [[17, "grag.components.llm.LLM.task", false]], "task (grag.components.prompt.fewshotprompt attribute)": [[17, "grag.components.prompt.FewShotPrompt.task", false]], "task (grag.components.prompt.prompt attribute)": [[17, "grag.components.prompt.Prompt.task", false], [17, "id13", false]], "task (grag.rag.basic_rag.basicrag attribute)": [[21, "grag.rag.basic_rag.BasicRAG.task", false]], "task (grag.rag.basic_rag.basicrag property)": [[21, "id2", false]], "temperature (grag.components.llm.llm attribute)": [[17, "grag.components.llm.LLM.temperature", false]], "template (grag.components.prompt.prompt attribute)": [[17, "grag.components.prompt.Prompt.template", false]], "test_connection() (grag.components.vectordb.chroma_client.chromaclient method)": [[18, "grag.components.vectordb.chroma_client.ChromaClient.test_connection", false]], "text_concat() (grag.components.parse_pdf.parsepdf method)": [[17, "grag.components.parse_pdf.ParsePDF.text_concat", false]], "text_splitter (grag.components.text_splitter.textsplitter attribute)": [[17, "grag.components.text_splitter.TextSplitter.text_splitter", false]], "textsplitter (class in grag.components.text_splitter)": [[17, "grag.components.text_splitter.TextSplitter", false]], "top_k (grag.components.multivec_retriever.retriever attribute)": [[17, "grag.components.multivec_retriever.Retriever.top_k", false]], "validate_doc_chain() (grag.components.prompt.prompt class method)": [[17, "grag.components.prompt.Prompt.validate_doc_chain", false]], "validate_examples() (grag.components.prompt.fewshotprompt class method)": [[17, "grag.components.prompt.FewShotPrompt.validate_examples", false]], "validate_input_keys() (grag.components.prompt.prompt class method)": [[17, "grag.components.prompt.Prompt.validate_input_keys", false]], "validate_output_keys() (grag.components.prompt.fewshotprompt class method)": [[17, "grag.components.prompt.FewShotPrompt.validate_output_keys", false]], "validate_task() (grag.components.prompt.prompt class method)": [[17, "grag.components.prompt.Prompt.validate_task", false]], "vectordb (class in grag.components.vectordb.base)": [[18, "grag.components.vectordb.base.VectorDB", false]], "vectordb (grag.components.multivec_retriever.retriever attribute)": [[17, "grag.components.multivec_retriever.Retriever.vectordb", false]]}, "objects": {"": [[16, 0, 0, "-", "grag"]], "grag": [[17, 0, 0, "-", "components"], [19, 0, 0, "-", "prompts"], [20, 0, 0, "-", "quantize"], [21, 0, 0, "-", "rag"]], "grag.components": [[17, 0, 0, "-", "embedding"], [17, 0, 0, "-", "llm"], [17, 0, 0, "-", "multivec_retriever"], [17, 0, 0, "-", "parse_pdf"], [17, 0, 0, "-", "prompt"], [17, 0, 0, "-", "text_splitter"], [17, 0, 0, "-", "utils"], [18, 0, 0, "-", "vectordb"]], "grag.components.embedding": [[17, 1, 1, "", "Embedding"]], "grag.components.embedding.Embedding": [[17, 2, 1, "", "embedding_function"], [17, 2, 1, "", "embedding_model"], [17, 2, 1, "", "embedding_type"]], "grag.components.llm": [[17, 1, 1, "", "LLM"]], "grag.components.llm.LLM": [[17, 2, 1, "", "device_map"], [17, 3, 1, "", "hf_pipeline"], [17, 3, 1, "", "llama_cpp"], [17, 3, 1, "", "load_model"], [17, 2, 1, "", "max_new_tokens"], [17, 4, 1, "id0", "model_name"], [17, 4, 1, "", "model_path"], [17, 2, 1, "", "n_batch"], [17, 2, 1, "", "n_ctx"], [17, 2, 1, "", "n_gpu_layers"], [17, 2, 1, "", "task"], [17, 2, 1, "", "temperature"]], "grag.components.multivec_retriever": [[17, 1, 1, "", "Retriever"]], "grag.components.multivec_retriever.Retriever": [[17, 3, 1, "", "aadd_docs"], [17, 3, 1, "", "add_docs"], [17, 3, 1, "", "aget_chunk"], [17, 3, 1, "", "aget_doc"], [17, 3, 1, "", "aingest"], [17, 3, 1, "", "gen_doc_ids"], [17, 3, 1, "", "get_chunk"], [17, 3, 1, "", "get_doc"], [17, 3, 1, "", "get_docs_from_chunks"], [17, 3, 1, "", "id_gen"], [17, 2, 1, "", "id_key"], [17, 3, 1, "", "ingest"], [17, 2, 1, "", "namespace"], [17, 2, 1, "", "retriever"], [17, 3, 1, "", "split_docs"], [17, 2, 1, "", "splitter"], [17, 2, 1, "", "store"], [17, 2, 1, "", "store_path"], [17, 2, 1, "", "top_k"], [17, 2, 1, "", "vectordb"]], "grag.components.parse_pdf": [[17, 1, 1, "", "ParsePDF"]], "grag.components.parse_pdf.ParsePDF": [[17, 2, 1, "", "add_caption_first"], [17, 2, 1, "", "add_captions_to_blocks"], [17, 2, 1, "", "add_captions_to_text"], [17, 3, 1, "", "classify"], [17, 2, 1, "", "extract_image_block_types"], [17, 2, 1, "", "extract_images"], [17, 2, 1, "", "image_output_dir"], [17, 2, 1, "", "infer_table_structure"], [17, 3, 1, "", "load_file"], [17, 3, 1, "", "partition"], [17, 3, 1, "", "process_images"], [17, 3, 1, "", "process_tables"], [17, 3, 1, "", "process_text"], [17, 2, 1, "", "single_text_out"], [17, 2, 1, "", "strategy"], [17, 3, 1, "", "text_concat"]], "grag.components.prompt": [[17, 1, 1, "", "FewShotPrompt"], [17, 1, 1, "", "Prompt"]], "grag.components.prompt.FewShotPrompt": [[17, 2, 1, "", "doc_chain"], [17, 2, 1, "id2", "example_template"], [17, 2, 1, "id3", "examples"], [17, 2, 1, "", "filepath"], [17, 2, 1, "id1", "input_keys"], [17, 2, 1, "", "language"], [17, 2, 1, "", "llm_type"], [17, 2, 1, "", "model_computed_fields"], [17, 2, 1, "", "model_config"], [17, 2, 1, "", "model_fields"], [17, 2, 1, "", "name"], [17, 2, 1, "", "output_keys"], [17, 2, 1, "id4", "prefix"], [17, 2, 1, "", "source"], [17, 2, 1, "id5", "suffix"], [17, 2, 1, "", "task"], [17, 3, 1, "", "validate_examples"], [17, 3, 1, "", "validate_output_keys"]], "grag.components.prompt.Prompt": [[17, 2, 1, "id6", "doc_chain"], [17, 2, 1, "id7", "filepath"], [17, 3, 1, "", "format"], [17, 2, 1, "id8", "input_keys"], [17, 2, 1, "id9", "language"], [17, 2, 1, "id10", "llm_type"], [17, 3, 1, "", "load"], [17, 2, 1, "", "model_computed_fields"], [17, 2, 1, "", "model_config"], [17, 2, 1, "", "model_fields"], [17, 2, 1, "id11", "name"], [17, 2, 1, "", "prompt"], [17, 3, 1, "", "save"], [17, 2, 1, "id12", "source"], [17, 2, 1, "id13", "task"], [17, 2, 1, "", "template"], [17, 3, 1, "", "validate_doc_chain"], [17, 3, 1, "", "validate_input_keys"], [17, 3, 1, "", "validate_task"]], "grag.components.text_splitter": [[17, 1, 1, "", "TextSplitter"]], "grag.components.text_splitter.TextSplitter": [[17, 2, 1, "", "chunk_overlap"], [17, 2, 1, "", "chunk_size"], [17, 2, 1, "", "text_splitter"]], "grag.components.utils": [[17, 5, 1, "", "find_config_path"], [17, 5, 1, "", "get_config"], [17, 5, 1, "", "stuff_docs"]], "grag.components.vectordb": [[18, 0, 0, "-", "base"], [18, 0, 0, "-", "chroma_client"], [18, 0, 0, "-", "deeplake_client"]], "grag.components.vectordb.base": [[18, 1, 1, "", "VectorDB"]], "grag.components.vectordb.base.VectorDB": [[18, 3, 1, "", "aadd_docs"], [18, 3, 1, "", "add_docs"], [18, 3, 1, "", "aget_chunk"], [18, 3, 1, "", "delete"], [18, 3, 1, "", "get_chunk"]], "grag.components.vectordb.chroma_client": [[18, 1, 1, "", "ChromaClient"]], "grag.components.vectordb.chroma_client.ChromaClient": [[18, 3, 1, "", "aadd_docs"], [18, 3, 1, "", "add_docs"], [18, 3, 1, "", "aget_chunk"], [18, 2, 1, "", "client"], [18, 2, 1, "", "collection"], [18, 2, 1, "", "collection_name"], [18, 3, 1, "", "delete"], [18, 2, 1, "", "embedding_function"], [18, 2, 1, "", "embedding_model"], [18, 2, 1, "", "embedding_type"], [18, 3, 1, "", "get_chunk"], [18, 2, 1, "", "host"], [18, 2, 1, "", "langchain_client"], [18, 2, 1, "", "port"], [18, 3, 1, "", "test_connection"]], "grag.components.vectordb.deeplake_client": [[18, 1, 1, "", "DeepLakeClient"]], "grag.components.vectordb.deeplake_client.DeepLakeClient": [[18, 3, 1, "", "aadd_docs"], [18, 3, 1, "", "add_docs"], [18, 3, 1, "", "aget_chunk"], [18, 2, 1, "", "client"], [18, 2, 1, "", "collection"], [18, 3, 1, "", "delete"], [18, 2, 1, "", "embedding_function"], [18, 2, 1, "", "embedding_model"], [18, 2, 1, "", "embedding_type"], [18, 3, 1, "", "get_chunk"], [18, 2, 1, "", "langchain_client"], [18, 2, 1, "", "store_path"]], "grag.quantize": [[20, 0, 0, "-", "quantize"], [20, 0, 0, "-", "utils"]], "grag.quantize.utils": [[20, 5, 1, "", "building_llamacpp"], [20, 5, 1, "", "fetch_model_repo"], [20, 5, 1, "", "get_llamacpp_repo"], [20, 5, 1, "", "quantize_model"]], "grag.rag": [[21, 0, 0, "-", "basic_rag"]], "grag.rag.basic_rag": [[21, 1, 1, "", "BasicRAG"]], "grag.rag.basic_rag.BasicRAG": [[21, 2, 1, "", "custom_prompt"], [21, 4, 1, "id0", "doc_chain"], [21, 2, 1, "", "llm_kwargs"], [21, 4, 1, "id1", "model_name"], [21, 3, 1, "", "output_parser"], [21, 3, 1, "", "prompt_matcher"], [21, 3, 1, "", "refine_call"], [21, 2, 1, "", "retriever_kwargs"], [21, 3, 1, "", "stuff_call"], [21, 3, 1, "", "stuff_docs"], [21, 4, 1, "id2", "task"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "method", "Python method"], "4": ["py", "property", "Python property"], "5": ["py", "function", "Python function"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:method", "4": "py:property", "5": "py:function"}, "terms": {"": 17, "0": [6, 8, 9, 17, 24], "00": [6, 9, 24], "000": [6, 9], "001": 24, "01": 24, "03": 24, "036": 24, "06": 24, "1": [8, 9, 17], "1024": 17, "12": 24, "13b": 17, "2": [2, 15, 17], "237": 24, "275": 24, "3": [8, 14, 17], "3f": 8, "400": 17, "484": 24, "5": [6, 24], "5000": 17, "6000": 17, "8000": [15, 18], "8c9040b0b5cd4d7cbc2e737da1b24ebf": 17, "935": 24, "A": [8, 17, 18, 20], "By": 15, "For": [3, 4, 12, 13, 14, 15], "If": [14, 15, 17], "It": [17, 22], "OR": 15, "The": [8, 17, 18, 20, 22], "To": [11, 15, 22], "_": [], "__fields__": 17, "__file__": [2, 15], "__init__": 8, "__main__": [3, 4, 8], "__name__": [3, 4, 8], "_build": [], "_queri": 8, "_static": [], "_top_k": 8, "aadd_doc": [16, 17, 18], "abc": 18, "about": [8, 17], "abov": [14, 17], "abstract": 18, "accuraci": 17, "activ": 8, "add": [17, 18], "add_caption_first": [16, 17], "add_captions_to_block": [16, 17], "add_captions_to_text": [16, 17], "add_doc": [16, 17, 18], "addit": 17, "address": [8, 18], "after": [14, 17], "aget_chunk": [16, 17, 18], "aget_doc": [16, 17], "aingest": [2, 16, 17], "alik": 8, "aliv": 18, "all": [5, 7, 17, 18, 19, 24], "also": [17, 22], "alt": [], "altern": 2, "alwai": 17, "an": [7, 13, 14, 22], "ani": [13, 15, 17, 22], "annot": 17, "answer": [0, 1], "anyth": 8, "api": [13, 18], "app": 8, "appli": 20, "applic": 8, "ar": [12, 14, 15], "arg": 8, "argument": [15, 17, 21], "artifici": 8, "arxiv": 18, "async": [2, 17, 18], "asynchron": [2, 17, 18], "asyncio": 2, "attempt": 20, "attribut": 8, "augment": [11, 22], "auth": 14, "auto": 17, "auto_exampl": [6, 9], "avail": 17, "awar": 17, "backend": 8, "bar": 18, "base": [0, 1, 8, 15, 16, 17, 21], "base_dir": 17, "basemodel": 17, "basi": 21, "basic": [0, 1, 6, 10, 16, 22, 23, 24], "basic_rag": [0, 1, 3, 4, 21], "basicrag": [0, 1, 3, 4, 16, 21, 23], "basicrag_customprompt": [0, 6, 24], "basicrag_fewshotprompt": [1, 6, 24], "basicrag_ingest": [2, 6, 24], "basicrag_refin": [3, 6, 24], "basicrag_stuff": [4, 6, 24], "batch": 17, "befor": 17, "being": 17, "below": [1, 5, 7], "better": 17, "block": 17, "blog": 8, "bool": [17, 18], "both": 15, "build": 20, "building_llamacpp": [16, 20, 23], "bulb": 8, "button": 8, "call": 17, "call_func": 21, "came": 1, "can": [12, 14, 15], "cannot": 17, "capstone_5": [17, 18], "caption": 17, "chain": [5, 6, 17, 21], "chang": [14, 15], "chat": 17, "check": [8, 14], "check_connect": 8, "chroma": [2, 8, 16, 17, 22], "chroma_cli": [2, 18], "chromacli": [2, 17, 18], "chromadb": 18, "chunk": [8, 17, 18], "chunk_overlap": [16, 17], "chunk_siz": [16, 17], "ci_test": 2, "class": [8, 17, 18, 21], "classifi": [16, 17], "classmethod": 17, "classvar": 17, "client": [2, 3, 4, 8, 15, 16, 17], "client_kwarg": 17, "clientserv": 15, "clone": [12, 14, 20], "cmake": 20, "co": 20, "code": [0, 1, 2, 3, 4, 5, 7, 8], "collect": [8, 17, 18], "collection_nam": [2, 3, 4, 8, 17, 18], "combin": 17, "command": 14, "complet": 13, "completedprocess": 20, "compon": [0, 1, 2, 3, 4, 8, 15, 16, 18, 22, 23], "comput": 17, "computedfieldinfo": 17, "concat": 17, "concaten": [17, 21], "concern": 13, "config": [12, 14, 15, 17], "configdict": 17, "configpars": 17, "configur": 17, "conform": 17, "connect": [8, 17, 18], "contain": [15, 17, 19, 20], "content": 23, "context": [0, 1, 17], "convolut": 1, "cookbook": [0, 1, 2, 3, 4, 8, 15, 22, 24], "copi": [14, 20], "core": 18, "correspond": [17, 18], "cosin": [17, 18], "cost": 13, "could": 8, "count": 8, "cpp": [14, 17, 20], "crucial": 15, "current": [15, 17], "current_path": 17, "custom": [5, 6, 12, 17], "custom_few_shot_prompt": 1, "custom_prompt": [0, 1, 16, 17, 21], "data": [2, 11, 13, 17, 18], "databas": [2, 15, 17, 18], "decor": 21, "deeplak": [15, 16, 17, 22], "deeplake_cli": [2, 3, 4, 18], "deeplakecli": [2, 3, 4, 15, 17, 18], "def": 8, "default": [15, 17, 18, 20, 21], "defin": 17, "delet": [17, 18], "demonstr": [0, 1, 2, 3, 4, 5, 7, 8], "deriv": 18, "detail": [8, 14, 15, 17], "develop": 12, "devic": 17, "device_map": [16, 17], "dict": [17, 21], "dictionari": 17, "differ": 19, "dimension": 15, "dir_path": [2, 15, 17], "directori": [14, 17, 20], "displai": 8, "doc": [8, 17, 18, 21], "doc_chain": [0, 1, 3, 4, 16, 17, 21], "doc_id": 17, "document": [5, 6, 17, 18, 21], "doe": [13, 14, 17], "download": [0, 1, 2, 3, 4, 5, 7, 8, 14, 20], "dry_run": 17, "dure": 17, "e": 12, "each": [17, 18], "easi": 22, "easiest": 14, "either": [14, 15], "element": 17, "elif": 2, "els": [8, 18], "embed": [8, 11, 16, 18, 23], "embedding_funct": [16, 17, 18], "embedding_model": [8, 15, 16, 17, 18], "embedding_modelnam": 18, "embedding_typ": [8, 15, 16, 17, 18], "en": 17, "enabl": 13, "end": [0, 1, 2, 3, 4, 8, 22], "ensur": 17, "enter": [8, 14], "enumer": 8, "etc": [14, 17], "exampl": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 14, 16, 17, 24], "example_templ": [1, 16, 17], "exclud": 17, "execut": [6, 9, 17, 24], "expand": 8, "explain": [], "explicitli": 15, "extern": 13, "extract": 17, "extract_imag": [16, 17], "extract_image_block_typ": [16, 17], "f": 8, "f16": 17, "face": 17, "fals": [8, 17, 18], "fetch_model_repo": [16, 20, 23], "few": [5, 6, 17], "fewshotprompt": [1, 16, 17, 21, 23], "field": 17, "fieldinfo": 17, "figur": 17, "file": [6, 9, 12, 14, 15, 17, 20, 24], "filenotfounderror": 17, "filepath": [16, 17], "final": 14, "find": [8, 14, 17], "find_config_path": [16, 17, 23], "flexibl": 14, "float": [17, 18], "folder": 15, "follow": [0, 1, 14], "form": [8, 14], "form_submit_button": 8, "format": [16, 17, 21], "found": 17, "from": [0, 1, 2, 3, 4, 6, 8, 9, 12, 14, 17, 18, 20, 24], "full": [0, 1, 2, 3, 4, 8], "function": [8, 17, 18, 20], "further": 12, "galleri": [0, 1, 2, 3, 4, 5, 7, 8, 24], "gate": 14, "gen_doc_id": [16, 17], "gener": [0, 1, 2, 3, 4, 5, 7, 8, 11, 15, 17, 22], "get": [14, 17, 22], "get_chunk": [8, 16, 17, 18], "get_config": [16, 17, 23], "get_doc": [16, 17], "get_docs_from_chunk": [16, 17], "get_llamacpp_repo": [16, 20, 23], "get_search_result": 8, "getcwd": 8, "gguf": 14, "git": [12, 20], "given": [0, 1, 17, 20], "glob": 17, "glob_pattern": 17, "go": [0, 1, 2, 3, 4, 8], "gpu": 17, "grag": [0, 1, 2, 3, 4, 8, 11, 14, 17, 18, 20, 21], "green": 8, "gui": [9, 10, 22], "gui_jupyt": 7, "gui_python": 7, "ha": [14, 17], "handl": 17, "has_result": 8, "have": 12, "hexadecim": 17, "hf_pipelin": [16, 17], "hi_r": 17, "high": 15, "hkunlp": 18, "hold": 8, "home": [8, 17, 18], "host": [8, 15, 17, 18], "how": [0, 1, 2, 3, 4, 11], "html": [], "http": 8, "httpclient": 18, "hug": 17, "huggingfac": [11, 15, 17, 20, 22], "i": [1, 5, 7, 8, 13, 14, 15, 17, 18, 20, 22], "id": [14, 17, 20], "id_gen": [16, 17], "id_kei": [16, 17], "identifi": 17, "illustr": [3, 4], "imag": 17, "image_output_dir": [16, 17], "implement": [13, 22], "import": [0, 1, 2, 3, 4, 8], "includ": 17, "index": 22, "infer_table_structur": [16, 17], "inform": [3, 4, 13], "ingest": [5, 6, 11, 16, 17], "ini": [12, 14, 15, 17], "initi": [8, 17], "input": [3, 4, 14, 17], "input_kei": [0, 1, 16, 17], "insert": 8, "instal": [11, 22], "instanc": [8, 17, 20], "instruct": 14, "instructor": [15, 17, 18], "int": [17, 18], "integ": 18, "integrag": 22, "intellig": 8, "interact": [8, 20], "interfac": 8, "introduc": 1, "io": 8, "ip": 18, "ipynb": [0, 1, 2, 3, 4, 8], "is_loc": 17, "its": 17, "join": [17, 21], "jpg": [], "json": 17, "jupit": 1, "jupyt": [0, 1, 2, 3, 4, 5, 7, 8], "just": 14, "k": 8, "kei": 17, "keyword": 21, "kwarg": [17, 21], "langchain": [3, 4, 17, 18], "langchain_cli": [17, 18], "langchain_commun": 18, "langchain_cor": [17, 21], "languag": [16, 17], "larg": 17, "largest": 1, "layer": 17, "lecun": 1, "len": 8, "level": 20, "like": [1, 8, 17, 22], "link": 17, "list": [8, 17, 18, 21], "llama": [14, 17, 20], "llama2": 17, "llama_cpp": [16, 17], "llamacpp": [11, 22], "llm": [11, 16, 19, 21, 22, 23], "llm_kwarg": [16, 21], "llm_type": [16, 17], "load": [16, 17], "load_env": 17, "load_fil": [16, 17], "load_model": [16, 17], "load_prompt": 17, "local": [14, 15, 17, 22], "localfilestor": 17, "localhost": 18, "locat": [17, 20], "look": 8, "lost": 8, "m": 14, "made": 12, "main": 8, "make": [14, 15, 20, 22], "manag": [8, 17], "map": 17, "markdown": 8, "match": 21, "max_new_token": [16, 17], "maximum": 17, "mb": [6, 9, 24], "mem": [6, 9, 24], "metadata": [8, 17], "metadata_toggl": 8, "method": 17, "min_valu": 8, "model": [8, 11, 15, 17, 18, 20, 21], "model_computed_field": [16, 17], "model_config": [16, 17], "model_dir_path": 20, "model_field": [16, 17], "model_nam": [14, 16, 17, 21], "model_path": [16, 17], "model_typ": 17, "modul": [22, 23], "more": [3, 4, 13, 14, 15, 17], "moreov": [], "most": [17, 18], "move": [15, 17], "much": 14, "multi": 17, "multi_vector": 17, "multivec_retriev": [2, 3, 4, 8, 17], "multivectorretriev": 17, "n": [8, 17], "n_batch": [16, 17], "n_ctx": [16, 17], "n_gpu_lay": [16, 17], "name": [1, 8, 14, 16, 17, 18, 21], "namespac": [16, 17], "network": 1, "neural": 1, "new": 17, "new_pap": 2, "nn": [17, 21], "non": 15, "none": [17, 18, 20, 21], "nonetyp": 17, "nosourc": 17, "note": 14, "notebook": [0, 1, 2, 3, 4, 5, 7, 8], "number": [8, 17, 18], "number_input": 8, "o": 8, "object": [17, 21], "offer": [14, 22], "one_to_on": 17, "onlin": 14, "open": 13, "oper": 20, "option": [8, 17, 20], "orchestr": 8, "otherwis": 8, "our": 15, "output": [17, 18, 21], "output_dir": 20, "output_kei": [1, 16, 17], "output_pars": [16, 21], "overlap": 17, "overview": [11, 22], "overwrit": 17, "packag": 22, "page": [8, 17, 21, 22], "page_cont": 8, "pagehom": 8, "pair": 17, "paramet": [8, 17, 18, 20, 21], "parent": [2, 8, 15, 17], "pars": [16, 23], "parse_pdf": 17, "parsepdf": [16, 17, 23], "parser": 17, "parser_kwarg": 17, "partit": [16, 17], "pass": 17, "path": [2, 8, 14, 15, 17, 18, 20], "pathlib": [2, 8], "pattern": 17, "pdf": [2, 15, 16, 23], "phase": 12, "pip": 12, "pipelin": [3, 4, 17], "place": 17, "planet": 1, "point": 17, "port": [8, 15, 17, 18], "prefix": [1, 16, 17], "print": 18, "priorit": 17, "privaci": 13, "process": [15, 17], "process_imag": [16, 17], "process_t": [16, 17], "process_text": [16, 17], "produc": 17, "progress": [17, 18], "project": 20, "prompt": [5, 6, 14, 16, 21, 22, 23], "prompt_match": [16, 21], "prompttempl": 17, "properti": [17, 21], "provid": [13, 14, 15, 17, 18, 19, 21, 22], "publish": 12, "pull": 20, "py": [0, 1, 2, 3, 4, 6, 8, 9, 24], "pydant": 17, "pypi": 12, "python": [0, 1, 2, 3, 4, 5, 7, 8, 14, 22], "q4_k_m": 14, "q5_k_m": [14, 17], "qa": [17, 21], "quantiz": [11, 16, 17, 22, 23], "quantize_model": [16, 20, 23], "queri": [3, 4, 8, 17, 18], "question": [0, 1], "rag": [0, 1, 3, 4, 6, 10, 15, 16, 22, 23, 24], "rag_jupyt": 5, "rag_python": 5, "rais": 17, "random": 18, "re": 13, "reach": 17, "read": 17, "read_onli": 18, "recommend": 14, "recurs": 17, "red": 8, "ref": [], "refer": [3, 4, 13, 15, 17], "refin": [5, 6, 17, 21], "refine_cal": [16, 21], "refine_chain_langchain_illustr": [], "relvant": 21, "render": 8, "render_search_form": 8, "render_search_result": 8, "render_sidebar": 8, "render_stat": 8, "replac": 17, "repo": 14, "repo_id": 20, "repositori": [12, 14, 20], "repr": 17, "repres": 8, "requir": [14, 17], "respect": 17, "respons": 8, "result": [8, 20], "retriev": [2, 3, 4, 9, 10, 11, 15, 16, 21, 22, 23], "retriever_app": [8, 9], "retriever_kwarg": [16, 21], "retriv": [7, 9], "return": [8, 17, 18, 20, 21], "root": [17, 20], "root_path": 20, "run": [2, 11, 15, 22], "run_chroma": 15, "same": 17, "sampl": 17, "save": [13, 16, 17, 20], "score": [8, 17, 18], "script": [15, 17], "search": [8, 17, 22], "search_form": 8, "self": [8, 17, 18], "semant": 8, "sentenc": [17, 18], "seper": [17, 21], "server": 15, "servic": 13, "session_st": 8, "set": [8, 14, 17], "sh": 15, "shot": [5, 6, 17], "should": [14, 17, 18, 20], "show": [8, 17, 18], "sidebar": 8, "similar": [8, 17, 18], "similiar": 8, "simpl": [7, 8, 22], "sinc": [12, 13, 15], "singl": [17, 18], "single_text_out": [16, 17], "size": 17, "slow": 2, "smaller": 17, "so": 17, "soifjpaosiujposoifj": [], "solut": [13, 22], "sourc": [0, 1, 2, 3, 4, 5, 7, 8, 13, 15, 16, 17, 18, 20, 21], "specifi": [17, 20], "sphinx": [0, 1, 2, 3, 4, 5, 7, 8], "sphx_glr_auto_examples_basicrag_customprompt": 24, "sphx_glr_auto_examples_basicrag_fewshotprompt": 24, "sphx_glr_auto_examples_basicrag_ingest": 24, "sphx_glr_auto_examples_basicrag_refin": 24, "sphx_glr_auto_examples_basicrag_stuff": 24, "spinner": 8, "split": 17, "split_doc": [16, 17], "splitter": [16, 23], "src": [12, 15], "st": 8, "start": [14, 17, 22], "state": 8, "static": 21, "statist": 8, "statu": 18, "std_out": 17, "step": 8, "storag": 17, "store": [11, 16, 17, 18, 22], "store_path": [16, 17, 18], "str": [8, 17, 18, 20, 21], "strategi": [16, 17], "streamlit": [7, 8], "stremlit": 8, "string": [17, 18, 21], "stuff": [0, 1, 5, 6, 17, 21], "stuff_cal": [16, 21], "stuff_chain_langchain_illustr": [], "stuff_doc": [16, 17, 21, 23], "submit": 8, "submodul": [16, 17, 23], "subprocess": 20, "suffix": [1, 16, 17], "support": [11, 17, 18, 22], "sure": [14, 15], "sy": 8, "sync": 2, "synchron": 2, "system": 8, "tab": 8, "tab1": 8, "tab2": 8, "tabl": 17, "table_as_html": 17, "take": 17, "task": [16, 17, 21], "temperatur": [16, 17], "templat": [0, 16, 17], "test": [2, 3, 4, 13, 18], "test_connect": [8, 17, 18], "text": [16, 23], "text_concat": [16, 17], "text_input": 8, "text_splitt": [16, 17], "textsplitt": [16, 17, 23], "thank": 22, "them": 17, "thi": [0, 1, 2, 3, 4, 8, 13, 14, 15, 17, 18, 21], "time": 17, "titl": 8, "toggl": 8, "token": [14, 17], "top": [8, 17, 18], "top_k": [8, 16, 17, 18], "total": [6, 9, 24], "transform": [17, 18], "travers": 17, "tree": 17, "true": [2, 3, 4, 8, 17, 18], "tupl": 18, "two": 14, "type": [8, 15, 17, 18, 21], "typic": 17, "ubuntu": [17, 18], "ui": 8, "under": 15, "union": 17, "uniqu": 17, "until": 17, "up": [1, 8, 17], "updat": 20, "us": [0, 1, 2, 3, 4, 5, 7, 8, 11, 13, 15, 17, 18, 20, 21, 22], "user": 14, "util": [16, 23], "uuid": 17, "uuid5": 17, "v": 17, "v1": 17, "valid": 17, "validate_doc_chain": [16, 17], "validate_exampl": [16, 17], "validate_input_kei": [16, 17], "validate_output_kei": [16, 17], "validate_task": [16, 17], "valu": [8, 17], "valueerror": 17, "variou": 22, "vector": [2, 11, 17, 18, 22], "vectordb": [2, 3, 4, 8, 15, 16, 23], "vectorstor": [15, 18], "verbos": [17, 18], "volume_2k": [17, 18], "wai": [14, 22], "want": 14, "we": 12, "web": 8, "well": 13, "what": [1, 8], "where": [14, 20], "whether": 17, "which": 17, "while": [3, 4], "who": 1, "width": [], "with_scor": [8, 17, 18], "wrapper": 18, "write": 8, "xl": [15, 18], "yann": 1, "yet": 12, "you": 14, "your": 8, "your_collection_nam": 2, "zip": [5, 7]}, "titles": ["Custom Prompts", "Custom Few-Shot Prompts", "Document Ingestion", "Refine Chain", "Stuff Chain", "Basic-RAG Cookbooks", "Computation times", "Retriever-GUI Cookbooks", "Retriever GUI", "Computation times", "Cookbooks", "Get Started", "Installation", "GRAG Overview", "To run LLMs using HuggingFace", "Vector Stores", "GRAG", "Components", "VectorDB", "Prompts", "Quantize", "RAG", "Welcome to GRAG\u2019s documentation!", "grag", "Computation times"], "titleterms": {"": 22, "To": 14, "augment": 13, "base": 18, "basic": [5, 21], "chain": [3, 4], "chroma": [15, 18], "client": 18, "compon": 17, "comput": [6, 9, 24], "content": [16, 17, 18, 19, 20, 21, 22], "cookbook": [5, 7, 10], "custom": [0, 1], "data": 15, "deeplak": 18, "document": [2, 22], "embed": [15, 17], "few": 1, "gener": 13, "get": 11, "grag": [13, 16, 22, 23], "gui": [7, 8], "how": 14, "huggingfac": 14, "indic": 22, "ingest": [2, 15], "instal": 12, "llamacpp": 14, "llm": [14, 17], "model": 14, "modul": [16, 17, 18, 19, 20, 21], "overview": 13, "pars": 17, "pdf": 17, "prompt": [0, 1, 17, 19], "quantiz": [14, 20], "rag": [5, 21], "refin": 3, "retriev": [7, 8, 13, 17], "run": 14, "shot": 1, "splitter": 17, "start": 11, "store": 15, "stuff": 4, "submodul": [18, 20, 21], "support": 15, "tabl": 22, "text": 17, "time": [6, 9, 24], "us": 14, "util": [17, 20], "vector": 15, "vectordb": [17, 18], "welcom": 22}}) \ No newline at end of file diff --git a/src/docs/auto_examples/Basic-RAG/Basic-RAG_jupyter.zip b/src/docs/auto_examples/Basic-RAG/Basic-RAG_jupyter.zip index ba5a94ecd3bfd857e3f2fda70a1b0aaf08145f65..f1bd6759d0a87b7047a065d89f0e75dd6226118f 100644 GIT binary patch delta 713 zcmccS@Y;F9SvJ1H+0!Fb8eBiRu`w{Xu}!|scCFqmzepiBzbI89GcPT_C^xYrGe1v9 zp(r&iwMd~PUm-fk(OoydGr-ly)6X?HRwJXNq@dVJUq3ywB%?G*FF8L~Kd~q)DKjrU zr&8ZJv7oplKQA@jR6i*vKS@6~F*8p;IX^!;35fNb5{omFb%EyTBbh1h8myO_5|gK| zsTY$Mlc%Srkd~QVT9j&KrJ$#$uctTpG`nGao`Ql^d1gvUhLwVafk6z2o0wB#r4W>w zmYJ8T;F6zQnwy$eQmo*d0klyepeR2%wYV6nE;BvPN+B62omvF4K|#SYC#STyqzLR& zh5R&-UqPlMgY{|z=a&{Gr&=laB<7`qjnjIl9va4AZkk)NZ<;@$%RsKZjc})7*xe2rD%Q3eJPm;xZZrSaorO$BwfDg}@r07uB?mH+?% delta 274 zcmaFue9d9QSvI~Clcq=fe3tdAnw5c}nsxGRwrf&0nYrl-#YM@sF-mEfIjL6q`aq6; zN`7+jWPc7rF(rla%#@N0psb03L5z|@VonK=J$VL)Jd={$=6@W21%yC`-fg$}+zT`m zghd!8?^hI?{EaPra+g#PJ`1X(4WzMK5L{B4mNt1Fha|+71B{!W$v$R6cmH*TV5UNz h$vTQ2jNFq;6}99sox%VITN>3S?^9G~dnyMK0ssw0Tqpnl diff --git a/src/docs/auto_examples/Basic-RAG/Basic-RAG_python.zip b/src/docs/auto_examples/Basic-RAG/Basic-RAG_python.zip index 6293a17d19d9cad735d1d225dd8b18cb9c8167ec..23acc3dc47a0343943e9080c0cfdce7712f837b4 100644 GIT binary patch delta 625 zcmX@0cwc41R%X7!+0!G|+eS27F*7h&F;70s+*!8Q|*U>E{}(V3Sc&Qc!HAub-Y-l2MwZmzF zQ>pKqSWsM&pO+eMs-KjTpQN9gn3<=aoS&ba1jPDIiN%@8xvk<65H4c5y|;nKHD zh}Yxd($iB&%Smyr*wG64X&`53=A|kmX8v_wWS5?NpZCS) z!>qsAz`;?r>3F3VFgU!JC!gVI8tlQ5$ZG`*jyb%VF2n>!aY<=f8iCN*e4qC;BYMKv y!5_dR%04-fO?tAbfEH6F_vAnUH3d-WK?D~AgCGL}Y-w!aojhGYneDFtNDu%t;>cA1 delta 212 zcmcbwazJszR%X5vlcqOQ9$sJohJ@*LhKth#seSpju_a( diff --git a/src/docs/auto_examples/Basic-RAG/BasicRAG_CustomPrompt_codeobj.pickle b/src/docs/auto_examples/Basic-RAG/BasicRAG_CustomPrompt_codeobj.pickle index 14f2765c72ec04bc0ce74f0ad57956a58d371677..be5857405e2ebd85679c37a80f3f693cce8b62c3 100644 GIT binary patch delta 138 zcmcc1c$aa4o*i32QGRYg$&}bBwNo^DSn?8cQ>XO61bf(W^HWN5fFfe)MTzNp$v~y~ zd8v6N#d-x`Z4+}0966j4i!+mh9Ni&iWU%)jL^3#ggupsMx|2Za;(@Fw8Qd8{89bdC Kyq%?qrFsB-{4=-! delta 138 zcmcc1c$aa4o*jo%VsU12kfZyQ*eSJBGLg__`>3SfX z1kw`^WKGO5aAXT8%Fit*f#}a*?}70%ID5pvI+B6X`FW{%CB=FL5TzO18A2I6of*8H IrHQ3_02od)xBvhE diff --git a/src/docs/auto_examples/Basic-RAG/BasicRAG_FewShotPrompt_codeobj.pickle b/src/docs/auto_examples/Basic-RAG/BasicRAG_FewShotPrompt_codeobj.pickle index 28e621850cfef7bc2a19c5f82802b4b76cd6f614..41bc3a031d6304ebfb5ad57a7ee9611b446d0f9a 100644 GIT binary patch delta 152 zcmaFO_?mHoo)52EYI$%*en~)4er`d@l-Mb?Q#5*5@)C1Xr}Uu7^|0mUrLg__`>3SfX z1kw`^WKFCx@aJ_)Ef3DfF9|5h&n+l{7?Z)?gC?B8*&_zlpA1x$pO>0fQmj`1(UHNO QA(X+>nZesxnpmm_06on)egFUf diff --git a/src/docs/auto_examples/Basic-RAG/BasicRAG_ingest_codeobj.pickle b/src/docs/auto_examples/Basic-RAG/BasicRAG_ingest_codeobj.pickle index d8dfee0f79a4669d836c7cf06a70baa6ce06367a..9c6b89baf4acab5ef90d69dfeaa38fa7ba7f4622 100644 GIT binary patch delta 27 jcmey!^pR=8?a6$M5scy!FBx&mWbkxm@OG9amg)fjkpl^o delta 27 jcmey!^pR=8?a8)`nvCKTFC}uzWbkxm@OG9amg)fjlf((b diff --git a/src/docs/auto_examples/Basic-RAG/BasicRAG_refine.ipynb b/src/docs/auto_examples/Basic-RAG/BasicRAG_refine.ipynb index 661b354..bb3575d 100644 --- a/src/docs/auto_examples/Basic-RAG/BasicRAG_refine.ipynb +++ b/src/docs/auto_examples/Basic-RAG/BasicRAG_refine.ipynb @@ -4,7 +4,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "# Refine Chain\nThis cookbook demonstrates how to use the refine chain for BasicRAG.\n\"Refine\n" + "# Refine Chain\nThis cookbook demonstrates how to use the refine chain for BasicRAG.\nFor more information, refer to [RAG-PIPELINES](https://github.com/arjbingly/Capstone_5/blob/main/cookbook/Basic-RAG/RAG-PIPELINES.md\n/).\n\n.. figure:: ../../_static/refine_chain_langchain_illustration.jpg\n :width: 800\n :alt: Refine Documents Chain Process\n :align: center\n\n Illustration of refine chain (Source: LangChain)\n" ] }, { diff --git a/src/docs/auto_examples/Basic-RAG/BasicRAG_refine.py b/src/docs/auto_examples/Basic-RAG/BasicRAG_refine.py index dffe7bd..853ce93 100644 --- a/src/docs/auto_examples/Basic-RAG/BasicRAG_refine.py +++ b/src/docs/auto_examples/Basic-RAG/BasicRAG_refine.py @@ -1,9 +1,16 @@ """Refine Chain ======================= This cookbook demonstrates how to use the refine chain for BasicRAG. -.. image:: src/docs/_static/refine_chain_langchain_illustration.jpg - :width: 400 +For more information, refer to `RAG-PIPELINES `_. + +.. figure:: ../../_static/refine_chain_langchain_illustration.jpg + :width: 800 :alt: Refine Documents Chain Process + :align: center + + Illustration of refine chain (Source: LangChain) + """ from grag.components.multivec_retriever import Retriever diff --git a/src/docs/auto_examples/Basic-RAG/BasicRAG_refine.rst b/src/docs/auto_examples/Basic-RAG/BasicRAG_refine.rst index 3d0a0ee..44e3cd1 100644 --- a/src/docs/auto_examples/Basic-RAG/BasicRAG_refine.rst +++ b/src/docs/auto_examples/Basic-RAG/BasicRAG_refine.rst @@ -20,11 +20,17 @@ Refine Chain ======================= This cookbook demonstrates how to use the refine chain for BasicRAG. -.. image:: src/docs/_static/refine_chain_langchain_illustration.jpg - :width: 400 +For more information, refer to `RAG-PIPELINES `_. + +.. figure:: ../../_static/refine_chain_langchain_illustration.jpg + :width: 800 :alt: Refine Documents Chain Process + :align: center + + Illustration of refine chain (Source: LangChain) -.. GENERATED FROM PYTHON SOURCE LINES 8-21 +.. GENERATED FROM PYTHON SOURCE LINES 15-28 .. code-block:: Python diff --git a/src/docs/auto_examples/Basic-RAG/BasicRAG_refine_codeobj.pickle b/src/docs/auto_examples/Basic-RAG/BasicRAG_refine_codeobj.pickle index dcc3aa2b33239ed04760df5a737701eb8b4c657f..4f5082a8bf9a6945bd371ee332b2ad58970703a8 100644 GIT binary patch delta 35 rcmdnWyp?&vy2*-+5o|&kJe?W56IWR=ichX$G+>mO_|$0fDn@Pq&Myle delta 36 scmdnWyp?&vy2%2JW{g6UD;SN~#4~t0Gk7PiieZ$Q?9ON~c@-l!0Ls7$aR2}S diff --git a/src/docs/auto_examples/Basic-RAG/BasicRAG_stuff.ipynb b/src/docs/auto_examples/Basic-RAG/BasicRAG_stuff.ipynb index 63895c6..a4430a5 100644 --- a/src/docs/auto_examples/Basic-RAG/BasicRAG_stuff.ipynb +++ b/src/docs/auto_examples/Basic-RAG/BasicRAG_stuff.ipynb @@ -4,7 +4,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "# Stuff Chain\nThis cookbook demonstrates how to use the stuff chain for BasicRAG.\n\"Stuff\n" + "# Stuff Chain\nThis cookbook demonstrates how to use the stuff chain for BasicRAG.\nFor more information, refer to [RAG-PIPELINES](https://github.com/arjbingly/Capstone_5/blob/main/cookbook/Basic-RAG/RAG-PIPELINES.md\n/).\n\n.. figure:: ../../_static/stuff_chain_langchain_illustration.jpg\n :width: 800\n :alt: Stuff Documents Chain Process\n :align: center\n\n Illustration of stuff chain (Source: LangChain)\n" ] }, { diff --git a/src/docs/auto_examples/Basic-RAG/BasicRAG_stuff.py b/src/docs/auto_examples/Basic-RAG/BasicRAG_stuff.py index 26d1f2c..360e3b1 100644 --- a/src/docs/auto_examples/Basic-RAG/BasicRAG_stuff.py +++ b/src/docs/auto_examples/Basic-RAG/BasicRAG_stuff.py @@ -1,9 +1,16 @@ """Stuff Chain ======================= This cookbook demonstrates how to use the stuff chain for BasicRAG. -.. image:: src/docs/_static/stuff_chain_langchain_illustration.jpg - :width: 400 +For more information, refer to `RAG-PIPELINES `_. + +.. figure:: ../../_static/stuff_chain_langchain_illustration.jpg + :width: 800 :alt: Stuff Documents Chain Process + :align: center + + Illustration of stuff chain (Source: LangChain) + """ from grag.components.multivec_retriever import Retriever diff --git a/src/docs/auto_examples/Basic-RAG/BasicRAG_stuff.rst b/src/docs/auto_examples/Basic-RAG/BasicRAG_stuff.rst index cd49781..988751d 100644 --- a/src/docs/auto_examples/Basic-RAG/BasicRAG_stuff.rst +++ b/src/docs/auto_examples/Basic-RAG/BasicRAG_stuff.rst @@ -20,11 +20,17 @@ Stuff Chain ======================= This cookbook demonstrates how to use the stuff chain for BasicRAG. -.. image:: src/docs/_static/stuff_chain_langchain_illustration.jpg - :width: 400 +For more information, refer to `RAG-PIPELINES `_. + +.. figure:: ../../_static/stuff_chain_langchain_illustration.jpg + :width: 800 :alt: Stuff Documents Chain Process + :align: center + + Illustration of stuff chain (Source: LangChain) -.. GENERATED FROM PYTHON SOURCE LINES 8-22 +.. GENERATED FROM PYTHON SOURCE LINES 15-29 .. code-block:: Python diff --git a/src/docs/auto_examples/Basic-RAG/BasicRAG_stuff_codeobj.pickle b/src/docs/auto_examples/Basic-RAG/BasicRAG_stuff_codeobj.pickle index dcc3aa2b33239ed04760df5a737701eb8b4c657f..4f5082a8bf9a6945bd371ee332b2ad58970703a8 100644 GIT binary patch delta 35 rcmdnWyp?&vy2*-+5o|&kJe?W56IWR=ichX$G+>mO_|$0fDn@Pq&Myle delta 36 scmdnWyp?&vy2%2JW{g6UD;SN~#4~t0Gk7PiieZ$Q?9ON~c@-l!0Ls7$aR2}S diff --git a/src/docs/auto_examples/Basic-RAG/index.rst b/src/docs/auto_examples/Basic-RAG/index.rst index b83cae3..a40c874 100644 --- a/src/docs/auto_examples/Basic-RAG/index.rst +++ b/src/docs/auto_examples/Basic-RAG/index.rst @@ -33,7 +33,7 @@ Below is a gallery of examples, demonstrating the use of Basic-RAG. .. raw:: html -
            +
            .. only:: html @@ -50,7 +50,7 @@ Below is a gallery of examples, demonstrating the use of Basic-RAG. .. raw:: html -
            +
            .. only:: html diff --git a/src/docs/auto_examples/Retriver-GUI/retriever_app_codeobj.pickle b/src/docs/auto_examples/Retriver-GUI/retriever_app_codeobj.pickle index 9c7f0eecce3cb80ca17f8b65c0dda7a655a17b92..ead1f483461b3d39145dc0490442c53e7c017597 100644 GIT binary patch delta 143 zcmaFL^^|MEgvmQubQpyu$FT%5icgMZHlJ+A$TfK%qXwhmWIbj*MzzVDjHZm*lb^9z zG8#;t$K=asI{6Kgs}*DL vWDzER#)yg64H;u6KWEfoOqy)ZXwH~Ec`CC3W6tChCQI%@u=dW<#8N!~g3u`Y delta 149 zcmV;G0BZl`3grrrkdqYyMgbC&Sp+cw7n7&~H31xxxCA!=A(LDKJpm?@M*%UD-2n=d zlmsIIFp~@e8|E&)lC4*@rm%>xRP`2;5c zQW diff --git a/src/docs/conf.py b/src/docs/conf.py index 7af170e..9cd6fba 100644 --- a/src/docs/conf.py +++ b/src/docs/conf.py @@ -45,7 +45,8 @@ "sphinx.ext.napoleon", "sphinx.ext.linkcode", # "sphinx_github_style" - "sphinx_gallery.gen_gallery" + "sphinx_gallery.gen_gallery", + "sphinx.ext.autosectionlabel" ] sphinx_gallery_conf = { @@ -72,6 +73,9 @@ def linkcode_resolve(domain, info): # Napoleon settings napoleon_google_docstring = True +# Autosectionlabel settings +autosectionlabel_prefix_document = True + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -91,3 +95,4 @@ def linkcode_resolve(domain, info): # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] + diff --git a/src/docs/get_started.introduction.rst b/src/docs/get_started.introduction.rst index 2bfccbd..74c2090 100644 --- a/src/docs/get_started.introduction.rst +++ b/src/docs/get_started.introduction.rst @@ -2,6 +2,10 @@ GRAG Overview ============= GRAG provides an implementation of Retrieval-Augmented Generation that is completely open-sourced. +Since it does not use any external services or APIs, this enables a cost-saving solution as well a solution to data privacy concerns. +For more information, refer to `our readme `_. Retrieval-Augmented Generation -############################### +############################## + +Retrieval-Augmented Generation \ No newline at end of file diff --git a/src/docs/get_started.llms.rst b/src/docs/get_started.llms.rst index 2157fb8..c284755 100644 --- a/src/docs/get_started.llms.rst +++ b/src/docs/get_started.llms.rst @@ -1,4 +1,4 @@ -LLMs + `LLMs ===== GRAG offers two ways to run LLMs locally: diff --git a/src/docs/get_started.rst b/src/docs/get_started.rst index b564b05..ca80073 100644 --- a/src/docs/get_started.rst +++ b/src/docs/get_started.rst @@ -3,6 +3,8 @@ Get Started .. toctree:: :maxdepth: 2 + get_started.introduction get_started.installation get_started.llms get_started.vectordb + diff --git a/src/docs/get_started.vectordb.rst b/src/docs/get_started.vectordb.rst index 1d12f58..f6f749a 100644 --- a/src/docs/get_started.vectordb.rst +++ b/src/docs/get_started.vectordb.rst @@ -1,3 +1,5 @@ +.. _Vector Stores: + Vector Stores ===============