From 2b2285dac0d6ae0f6b7c09c33882a0d5be26c078 Mon Sep 17 00:00:00 2001 From: BeatrixCohere <128378696+BeatrixCohere@users.noreply.github.com> Date: Wed, 24 Jan 2024 03:39:42 +0000 Subject: [PATCH] docs: Update cohere rerank and comparison docs (#16198) - **Description:** Update the cohere rerank docs to use cohere embeddings - **Issue:** n/a - **Dependencies:** n/a - **Twitter handle:** n/a --- docs/docs/guides/model_laboratory.ipynb | 28 +- .../retrievers/cohere-reranker.ipynb | 332 ++++++++---------- 2 files changed, 168 insertions(+), 192 deletions(-) diff --git a/docs/docs/guides/model_laboratory.ipynb b/docs/docs/guides/model_laboratory.ipynb index b6533de4c0d..540bc4023fb 100644 --- a/docs/docs/guides/model_laboratory.ipynb +++ b/docs/docs/guides/model_laboratory.ipynb @@ -35,6 +35,22 @@ "from langchain_openai import OpenAI" ] }, + { + "cell_type": "code", + "execution_count": null, + "id": "3dd69cb4", + "metadata": {}, + "outputs": [], + "source": [ + "import getpass\n", + "import os\n", + "\n", + "# get a new token: https://dashboard.cohere.ai/\n", + "os.environ[\"COHERE_API_KEY\"] = getpass.getpass(\"Cohere API Key:\")\n", + "os.environ[\"OPENAI_API_KEY\"] = getpass.getpass(\"Open API Key:\")\n", + "os.environ[\"HUGGINGFACEHUB_API_TOKEN\"] = getpass.getpass(\"Hugging Face API Key:\")" + ] + }, { "cell_type": "code", "execution_count": 2, @@ -44,7 +60,7 @@ "source": [ "llms = [\n", " OpenAI(temperature=0),\n", - " Cohere(model=\"command-xlarge-20221108\", max_tokens=20, temperature=0),\n", + " Cohere(temperature=0),\n", " HuggingFaceHub(repo_id=\"google/flan-t5-xl\", model_kwargs={\"temperature\": 1}),\n", "]" ] @@ -160,7 +176,7 @@ " llm=open_ai_llm, search_chain=search, verbose=True\n", ")\n", "\n", - "cohere_llm = Cohere(temperature=0, model=\"command-xlarge-20221108\")\n", + "cohere_llm = Cohere(temperature=0)\n", "search = SerpAPIWrapper()\n", "self_ask_with_search_cohere = SelfAskWithSearchChain(\n", " llm=cohere_llm, search_chain=search, verbose=True\n", @@ -241,14 +257,6 @@ "source": [ "model_lab.compare(\"What is the hometown of the reigning men's U.S. Open champion?\")" ] - }, - { - "cell_type": "code", - "execution_count": null, - "id": "94159131", - "metadata": {}, - "outputs": [], - "source": [] } ], "metadata": { diff --git a/docs/docs/integrations/retrievers/cohere-reranker.ipynb b/docs/docs/integrations/retrievers/cohere-reranker.ipynb index afdf5e2f588..24c58ff5d48 100644 --- a/docs/docs/integrations/retrievers/cohere-reranker.ipynb +++ b/docs/docs/integrations/retrievers/cohere-reranker.ipynb @@ -24,7 +24,7 @@ }, { "cell_type": "code", - "execution_count": 1, + "execution_count": null, "id": "b37bd138-4f3c-4d2c-bc4b-be705ce27a09", "metadata": { "tags": [] @@ -40,7 +40,7 @@ }, { "cell_type": "code", - "execution_count": null, + "execution_count": 13, "id": "c47b0b26-6d51-4beb-aedb-ad09740a9a2b", "metadata": {}, "outputs": [], @@ -55,19 +55,12 @@ }, { "cell_type": "code", - "execution_count": null, - "id": "2268c17f-5cc3-457b-928b-0d470154c3a8", - "metadata": {}, - "outputs": [], - "source": [ - "os.environ[\"OPENAI_API_KEY\"] = getpass.getpass(\"OpenAI API Key:\")" - ] - }, - { - "cell_type": "code", - "execution_count": 2, - "id": "28e8dc12", - "metadata": {}, + "execution_count": 14, + "id": "6fa3d916", + "metadata": { + "jp-MarkdownHeadingCollapsed": true, + "tags": [] + }, "outputs": [], "source": [ "# Helper function for printing docs\n", @@ -95,8 +88,8 @@ }, { "cell_type": "code", - "execution_count": 22, - "id": "9fbcc58f", + "execution_count": 15, + "id": "b7648612", "metadata": {}, "outputs": [ { @@ -111,28 +104,20 @@ "----------------------------------------------------------------------------------------------------\n", "Document 2:\n", "\n", + "We cannot let this happen. \n", + "\n", + "Tonight. I call on the Senate to: Pass the Freedom to Vote Act. Pass the John Lewis Voting Rights Act. And while you’re at it, pass the Disclose Act so Americans can know who is funding our elections. \n", + "\n", + "Tonight, I’d like to honor someone who has dedicated his life to serve this country: Justice Stephen Breyer—an Army veteran, Constitutional scholar, and retiring Justice of the United States Supreme Court. Justice Breyer, thank you for your service.\n", + "----------------------------------------------------------------------------------------------------\n", + "Document 3:\n", + "\n", "As I said last year, especially to our younger transgender Americans, I will always have your back as your President, so you can be yourself and reach your God-given potential. \n", "\n", "While it often appears that we never agree, that isn’t true. I signed 80 bipartisan bills into law last year. From preventing government shutdowns to protecting Asian-Americans from still-too-common hate crimes to reforming military justice.\n", "----------------------------------------------------------------------------------------------------\n", - "Document 3:\n", - "\n", - "A former top litigator in private practice. A former federal public defender. And from a family of public school educators and police officers. A consensus builder. Since she’s been nominated, she’s received a broad range of support—from the Fraternal Order of Police to former judges appointed by Democrats and Republicans. \n", - "\n", - "And if we are to advance liberty and justice, we need to secure the Border and fix the immigration system.\n", - "----------------------------------------------------------------------------------------------------\n", "Document 4:\n", "\n", - "He met the Ukrainian people. \n", - "\n", - "From President Zelenskyy to every Ukrainian, their fearlessness, their courage, their determination, inspires the world. \n", - "\n", - "Groups of citizens blocking tanks with their bodies. Everyone from students to retirees teachers turned soldiers defending their homeland. \n", - "\n", - "In this struggle as President Zelenskyy said in his speech to the European Parliament “Light will win over darkness.” The Ukrainian Ambassador to the United States is here tonight.\n", - "----------------------------------------------------------------------------------------------------\n", - "Document 5:\n", - "\n", "I spoke with their families and told them that we are forever in debt for their sacrifice, and we will carry on their mission to restore the trust and safety every community deserves. \n", "\n", "I’ve worked on these issues a long time. \n", @@ -141,64 +126,86 @@ "\n", "So let’s not abandon our streets. Or choose between safety and equal justice.\n", "----------------------------------------------------------------------------------------------------\n", + "Document 5:\n", + "\n", + "He met the Ukrainian people. \n", + "\n", + "From President Zelenskyy to every Ukrainian, their fearlessness, their courage, their determination, inspires the world. \n", + "\n", + "Groups of citizens blocking tanks with their bodies. Everyone from students to retirees teachers turned soldiers defending their homeland. \n", + "\n", + "In this struggle as President Zelenskyy said in his speech to the European Parliament “Light will win over darkness.” The Ukrainian Ambassador to the United States is here tonight.\n", + "----------------------------------------------------------------------------------------------------\n", "Document 6:\n", "\n", + "So let’s not abandon our streets. Or choose between safety and equal justice. \n", + "\n", + "Let’s come together to protect our communities, restore trust, and hold law enforcement accountable. \n", + "\n", + "That’s why the Justice Department required body cameras, banned chokeholds, and restricted no-knock warrants for its officers.\n", + "----------------------------------------------------------------------------------------------------\n", + "Document 7:\n", + "\n", + "But that trickle-down theory led to weaker economic growth, lower wages, bigger deficits, and the widest gap between those at the top and everyone else in nearly a century. \n", + "\n", "Vice President Harris and I ran for office with a new economic vision for America. \n", "\n", "Invest in America. Educate Americans. Grow the workforce. Build the economy from the bottom up \n", - "and the middle out, not from the top down. \n", - "\n", - "Because we know that when the middle class grows, the poor have a ladder up and the wealthy do very well. \n", - "\n", - "America used to have the best roads, bridges, and airports on Earth. \n", - "\n", - "Now our infrastructure is ranked 13th in the world.\n", - "----------------------------------------------------------------------------------------------------\n", - "Document 7:\n", - "\n", - "And tonight, I’m announcing that the Justice Department will name a chief prosecutor for pandemic fraud. \n", - "\n", - "By the end of this year, the deficit will be down to less than half what it was before I took office. \n", - "\n", - "The only president ever to cut the deficit by more than one trillion dollars in a single year. \n", - "\n", - "Lowering your costs also means demanding more competition. \n", - "\n", - "I’m a capitalist, but capitalism without competition isn’t capitalism. \n", - "\n", - "It’s exploitation—and it drives up prices.\n", + "and the middle out, not from the top down.\n", "----------------------------------------------------------------------------------------------------\n", "Document 8:\n", "\n", - "For the past 40 years we were told that if we gave tax breaks to those at the very top, the benefits would trickle down to everyone else. \n", + "A former top litigator in private practice. A former federal public defender. And from a family of public school educators and police officers. A consensus builder. Since she’s been nominated, she’s received a broad range of support—from the Fraternal Order of Police to former judges appointed by Democrats and Republicans. \n", "\n", - "But that trickle-down theory led to weaker economic growth, lower wages, bigger deficits, and the widest gap between those at the top and everyone else in nearly a century. \n", - "\n", - "Vice President Harris and I ran for office with a new economic vision for America.\n", + "And if we are to advance liberty and justice, we need to secure the Border and fix the immigration system.\n", "----------------------------------------------------------------------------------------------------\n", "Document 9:\n", "\n", - "All told, we created 369,000 new manufacturing jobs in America just last year. \n", + "The widow of Sergeant First Class Heath Robinson. \n", "\n", - "Powered by people I’ve met like JoJo Burgess, from generations of union steelworkers from Pittsburgh, who’s here with us tonight. \n", + "He was born a soldier. Army National Guard. Combat medic in Kosovo and Iraq. \n", + "\n", + "Stationed near Baghdad, just yards from burn pits the size of football fields. \n", + "\n", + "Heath’s widow Danielle is here with us tonight. They loved going to Ohio State football games. He loved building Legos with their daughter. \n", + "\n", + "But cancer from prolonged exposure to burn pits ravaged Heath’s lungs and body. \n", + "\n", + "Danielle says Heath was a fighter to the very end.\n", + "----------------------------------------------------------------------------------------------------\n", + "Document 10:\n", + "\n", + "As I’ve told Xi Jinping, it is never a good bet to bet against the American people. \n", + "\n", + "We’ll create good jobs for millions of Americans, modernizing roads, airports, ports, and waterways all across America. \n", + "\n", + "And we’ll do it all to withstand the devastating effects of the climate crisis and promote environmental justice.\n", + "----------------------------------------------------------------------------------------------------\n", + "Document 11:\n", "\n", "As Ohio Senator Sherrod Brown says, “It’s time to bury the label “Rust Belt.” \n", "\n", "It’s time. \n", "\n", - "But with all the bright spots in our economy, record job growth and higher wages, too many families are struggling to keep up with the bills.\n", + "But with all the bright spots in our economy, record job growth and higher wages, too many families are struggling to keep up with the bills. \n", + "\n", + "Inflation is robbing them of the gains they might otherwise feel. \n", + "\n", + "I get it. That’s why my top priority is getting prices under control.\n", "----------------------------------------------------------------------------------------------------\n", - "Document 10:\n", + "Document 12:\n", "\n", - "I’m also calling on Congress: pass a law to make sure veterans devastated by toxic exposures in Iraq and Afghanistan finally get the benefits and comprehensive health care they deserve. \n", + "This was a bipartisan effort, and I want to thank the members of both parties who worked to make it happen. \n", "\n", - "And fourth, let’s end cancer as we know it. \n", + "We’re done talking about infrastructure weeks. \n", "\n", - "This is personal to me and Jill, to Kamala, and to so many of you. \n", + "We’re going to have an infrastructure decade. \n", "\n", - "Cancer is the #2 cause of death in America–second only to heart disease.\n", + "It is going to transform America and put us on a path to win the economic competition of the 21st Century that we face with the rest of the world—particularly with China. \n", + "\n", + "As I’ve told Xi Jinping, it is never a good bet to bet against the American people.\n", "----------------------------------------------------------------------------------------------------\n", - "Document 11:\n", + "Document 13:\n", "\n", "He will never extinguish their love of freedom. He will never weaken the resolve of the free world. \n", "\n", @@ -210,100 +217,8 @@ "\n", "I understand.\n", "----------------------------------------------------------------------------------------------------\n", - "Document 12:\n", - "\n", - "Madam Speaker, Madam Vice President, our First Lady and Second Gentleman. Members of Congress and the Cabinet. Justices of the Supreme Court. My fellow Americans. \n", - "\n", - "Last year COVID-19 kept us apart. This year we are finally together again. \n", - "\n", - "Tonight, we meet as Democrats Republicans and Independents. But most importantly as Americans. \n", - "\n", - "With a duty to one another to the American people to the Constitution. \n", - "\n", - "And with an unwavering resolve that freedom will always triumph over tyranny.\n", - "----------------------------------------------------------------------------------------------------\n", - "Document 13:\n", - "\n", - "I know. \n", - "\n", - "One of those soldiers was my son Major Beau Biden. \n", - "\n", - "We don’t know for sure if a burn pit was the cause of his brain cancer, or the diseases of so many of our troops. \n", - "\n", - "But I’m committed to finding out everything we can. \n", - "\n", - "Committed to military families like Danielle Robinson from Ohio. \n", - "\n", - "The widow of Sergeant First Class Heath Robinson. \n", - "\n", - "He was born a soldier. Army National Guard. Combat medic in Kosovo and Iraq.\n", - "----------------------------------------------------------------------------------------------------\n", "Document 14:\n", "\n", - "And soon, we’ll strengthen the Violence Against Women Act that I first wrote three decades ago. It is important for us to show the nation that we can come together and do big things. \n", - "\n", - "So tonight I’m offering a Unity Agenda for the Nation. Four big things we can do together. \n", - "\n", - "First, beat the opioid epidemic. \n", - "\n", - "There is so much we can do. Increase funding for prevention, treatment, harm reduction, and recovery.\n", - "----------------------------------------------------------------------------------------------------\n", - "Document 15:\n", - "\n", - "Third, support our veterans. \n", - "\n", - "Veterans are the best of us. \n", - "\n", - "I’ve always believed that we have a sacred obligation to equip all those we send to war and care for them and their families when they come home. \n", - "\n", - "My administration is providing assistance with job training and housing, and now helping lower-income veterans get VA care debt-free. \n", - "\n", - "Our troops in Iraq and Afghanistan faced many dangers.\n", - "----------------------------------------------------------------------------------------------------\n", - "Document 16:\n", - "\n", - "When we invest in our workers, when we build the economy from the bottom up and the middle out together, we can do something we haven’t done in a long time: build a better America. \n", - "\n", - "For more than two years, COVID-19 has impacted every decision in our lives and the life of the nation. \n", - "\n", - "And I know you’re tired, frustrated, and exhausted. \n", - "\n", - "But I also know this.\n", - "----------------------------------------------------------------------------------------------------\n", - "Document 17:\n", - "\n", - "Now is the hour. \n", - "\n", - "Our moment of responsibility. \n", - "\n", - "Our test of resolve and conscience, of history itself. \n", - "\n", - "It is in this moment that our character is formed. Our purpose is found. Our future is forged. \n", - "\n", - "Well I know this nation. \n", - "\n", - "We will meet the test. \n", - "\n", - "To protect freedom and liberty, to expand fairness and opportunity. \n", - "\n", - "We will save democracy. \n", - "\n", - "As hard as these times have been, I am more optimistic about America today than I have been my whole life.\n", - "----------------------------------------------------------------------------------------------------\n", - "Document 18:\n", - "\n", - "He didn’t know how to stop fighting, and neither did she. \n", - "\n", - "Through her pain she found purpose to demand we do better. \n", - "\n", - "Tonight, Danielle—we are. \n", - "\n", - "The VA is pioneering new ways of linking toxic exposures to diseases, already helping more veterans get benefits. \n", - "\n", - "And tonight, I’m announcing we’re expanding eligibility to veterans suffering from nine respiratory cancers.\n", - "----------------------------------------------------------------------------------------------------\n", - "Document 19:\n", - "\n", "I understand. \n", "\n", "I remember when my Dad had to leave our home in Scranton, Pennsylvania to find work. I grew up in a family where if the price of food went up, you felt it. \n", @@ -314,26 +229,87 @@ "\n", "Few pieces of legislation have done more in a critical moment in our history to lift us out of crisis.\n", "----------------------------------------------------------------------------------------------------\n", + "Document 15:\n", + "\n", + "My administration is providing assistance with job training and housing, and now helping lower-income veterans get VA care debt-free. \n", + "\n", + "Our troops in Iraq and Afghanistan faced many dangers. \n", + "\n", + "One was stationed at bases and breathing in toxic smoke from “burn pits” that incinerated wastes of war—medical and hazard material, jet fuel, and more. \n", + "\n", + "When they came home, many of the world’s fittest and best trained warriors were never the same. \n", + "\n", + "Headaches. Numbness. Dizziness.\n", + "----------------------------------------------------------------------------------------------------\n", + "Document 16:\n", + "\n", + "Danielle says Heath was a fighter to the very end. \n", + "\n", + "He didn’t know how to stop fighting, and neither did she. \n", + "\n", + "Through her pain she found purpose to demand we do better. \n", + "\n", + "Tonight, Danielle—we are. \n", + "\n", + "The VA is pioneering new ways of linking toxic exposures to diseases, already helping more veterans get benefits. \n", + "\n", + "And tonight, I’m announcing we’re expanding eligibility to veterans suffering from nine respiratory cancers.\n", + "----------------------------------------------------------------------------------------------------\n", + "Document 17:\n", + "\n", + "Cancer is the #2 cause of death in America–second only to heart disease. \n", + "\n", + "Last month, I announced our plan to supercharge \n", + "the Cancer Moonshot that President Obama asked me to lead six years ago. \n", + "\n", + "Our goal is to cut the cancer death rate by at least 50% over the next 25 years, turn more cancers from death sentences into treatable diseases. \n", + "\n", + "More support for patients and families. \n", + "\n", + "To get there, I call on Congress to fund ARPA-H, the Advanced Research Projects Agency for Health.\n", + "----------------------------------------------------------------------------------------------------\n", + "Document 18:\n", + "\n", + "My plan to fight inflation will lower your costs and lower the deficit. \n", + "\n", + "17 Nobel laureates in economics say my plan will ease long-term inflationary pressures. Top business leaders and most Americans support my plan. And here’s the plan: \n", + "\n", + "First – cut the cost of prescription drugs. Just look at insulin. One in ten Americans has diabetes. In Virginia, I met a 13-year-old boy named Joshua Davis.\n", + "----------------------------------------------------------------------------------------------------\n", + "Document 19:\n", + "\n", + "Let’s pass the Paycheck Fairness Act and paid leave. \n", + "\n", + "Raise the minimum wage to $15 an hour and extend the Child Tax Credit, so no one has to raise a family in poverty. \n", + "\n", + "Let’s increase Pell Grants and increase our historic support of HBCUs, and invest in what Jill—our First Lady who teaches full-time—calls America’s best-kept secret: community colleges. \n", + "\n", + "And let’s pass the PRO Act when a majority of workers want to form a union—they shouldn’t be stopped.\n", + "----------------------------------------------------------------------------------------------------\n", "Document 20:\n", "\n", - "So let’s not abandon our streets. Or choose between safety and equal justice. \n", + "Madam Speaker, Madam Vice President, our First Lady and Second Gentleman. Members of Congress and the Cabinet. Justices of the Supreme Court. My fellow Americans. \n", "\n", - "Let’s come together to protect our communities, restore trust, and hold law enforcement accountable. \n", + "Last year COVID-19 kept us apart. This year we are finally together again. \n", "\n", - "That’s why the Justice Department required body cameras, banned chokeholds, and restricted no-knock warrants for its officers.\n" + "Tonight, we meet as Democrats Republicans and Independents. But most importantly as Americans. \n", + "\n", + "With a duty to one another to the American people to the Constitution. \n", + "\n", + "And with an unwavering resolve that freedom will always triumph over tyranny.\n" ] } ], "source": [ "from langchain.text_splitter import RecursiveCharacterTextSplitter\n", "from langchain_community.document_loaders import TextLoader\n", + "from langchain_community.embeddings import CohereEmbeddings\n", "from langchain_community.vectorstores import FAISS\n", - "from langchain_openai import OpenAIEmbeddings\n", "\n", "documents = TextLoader(\"../../modules/state_of_the_union.txt\").load()\n", "text_splitter = RecursiveCharacterTextSplitter(chunk_size=500, chunk_overlap=100)\n", "texts = text_splitter.split_documents(documents)\n", - "retriever = FAISS.from_documents(texts, OpenAIEmbeddings()).as_retriever(\n", + "retriever = FAISS.from_documents(texts, CohereEmbeddings()).as_retriever(\n", " search_kwargs={\"k\": 20}\n", ")\n", "\n", @@ -353,8 +329,8 @@ }, { "cell_type": "code", - "execution_count": 31, - "id": "9a658023", + "execution_count": 16, + "id": "b83dfedb", "metadata": {}, "outputs": [ { @@ -388,9 +364,9 @@ "source": [ "from langchain.retrievers import ContextualCompressionRetriever\n", "from langchain.retrievers.document_compressors import CohereRerank\n", - "from langchain_openai import OpenAI\n", + "from langchain_community.llms import Cohere\n", "\n", - "llm = OpenAI(temperature=0)\n", + "llm = Cohere(temperature=0)\n", "compressor = CohereRerank()\n", "compression_retriever = ContextualCompressionRetriever(\n", " base_compressor=compressor, base_retriever=retriever\n", @@ -412,7 +388,7 @@ }, { "cell_type": "code", - "execution_count": 32, + "execution_count": 17, "id": "367dafe0", "metadata": {}, "outputs": [], @@ -422,19 +398,19 @@ }, { "cell_type": "code", - "execution_count": 33, + "execution_count": 18, "id": "ae697ca4", "metadata": {}, "outputs": [], "source": [ "chain = RetrievalQA.from_chain_type(\n", - " llm=OpenAI(temperature=0), retriever=compression_retriever\n", + " llm=Cohere(temperature=0), retriever=compression_retriever\n", ")" ] }, { "cell_type": "code", - "execution_count": 34, + "execution_count": 19, "id": "46ee62fc", "metadata": {}, "outputs": [ @@ -442,10 +418,10 @@ "data": { "text/plain": [ "{'query': 'What did the president say about Ketanji Brown Jackson',\n", - " 'result': \" The president said that Ketanji Brown Jackson is one of the nation's top legal minds and that she is a consensus builder who has received a broad range of support from the Fraternal Order of Police to former judges appointed by Democrats and Republicans.\"}" + " 'result': \" The president speaks highly of Ketanji Brown Jackson, stating that she is one of the nation's top legal minds, and will continue the legacy of excellence of Justice Breyer. The president also mentions that he worked with her family and that she comes from a family of public school educators and police officers. Since her nomination, she has received support from various groups, including the Fraternal Order of Police and judges from both major political parties. \\n\\nWould you like me to extract another sentence from the provided text? \"}" ] }, - "execution_count": 34, + "execution_count": 19, "metadata": {}, "output_type": "execute_result" } @@ -453,14 +429,6 @@ "source": [ "chain({\"query\": query})" ] - }, - { - "cell_type": "code", - "execution_count": null, - "id": "700a8133", - "metadata": {}, - "outputs": [], - "source": [] } ], "metadata": {