From 2d9719946a56f09953021fae873a9ebe830724ff Mon Sep 17 00:00:00 2001 From: Mendon Kissling <59585235+mendonk@users.noreply.github.com> Date: Tue, 28 May 2024 11:11:11 -0400 Subject: [PATCH] hf-spaces-and-subfolder --- .../getting-started/huggingface-spaces.mdx | 14 ----------- .../docs/getting-started/install-langflow.mdx | 23 +++++++++++++++++-- docs/docs/getting-started/quickstart.mdx | 2 +- docs/sidebars.js | 11 ++++++--- 4 files changed, 30 insertions(+), 20 deletions(-) diff --git a/docs/docs/getting-started/huggingface-spaces.mdx b/docs/docs/getting-started/huggingface-spaces.mdx index d2eccc782..2c9968617 100644 --- a/docs/docs/getting-started/huggingface-spaces.mdx +++ b/docs/docs/getting-started/huggingface-spaces.mdx @@ -22,17 +22,3 @@ You'll be presented with the following screen: Name your Space, define the visibility (Public or Private), and click on **Duplicate Space** to start the installation process. When installation is finished, you'll be redirected to the Space's main page to start using Langflow right away! -## Run a starter project - -Langflow provides a range of example flows to help you get started. - -Once you get Langflow running in your Space, click on **New Project** in the top right corner of the screen. - -Select a starter project from the list, set up your API keys, and click ⚡ Run. This will open up Langflow's Interaction Panel with the chat console, text inputs, and outputs ready to go. - -For more information on the starter projects, see the guides below: - -* [Basic prompting](/starter-projects/basic-prompting.mdx) -* [Memory chatbot](/starter-projects/memory-chatbot.mdx) -* [Blog writer](/starter-projects/blog-writer.mdx) -* [Document QA](/starter-projects/document-qa.mdx) \ No newline at end of file diff --git a/docs/docs/getting-started/install-langflow.mdx b/docs/docs/getting-started/install-langflow.mdx index 7a567d597..81ad7b09a 100644 --- a/docs/docs/getting-started/install-langflow.mdx +++ b/docs/docs/getting-started/install-langflow.mdx @@ -7,7 +7,7 @@ import Admonition from "@theme/Admonition"; - Langflow v1.0 alpha is also available in [HuggingFace Spaces](https://huggingface.co/spaces/Langflow/Langflow-Preview?duplicate=true). Try it out or follow the instructions [here](./huggingface-spaces) to install it locally. + Langflow v1.0 alpha is also available in [HuggingFace Spaces](https://huggingface.co/spaces/Langflow/Langflow-Preview?duplicate=true). Try it out or follow the instructions [here](./install-langflow##huggingface-spaces) to install it locally. @@ -66,4 +66,23 @@ python -m langflow run │ Collaborate, and contribute at our GitHub Repo 🚀 │ ``` -3. Continue on to the [Quickstart](./quickstart.mdx). \ No newline at end of file +3. Continue on to the [Quickstart](./quickstart.mdx). + +## HuggingFace Spaces + +HuggingFace provides a great alternative for running Langflow in their Spaces environment. This means you can run Langflow without any local installation required. + +In a Chromium-based browser, go to the [Langflow Space](https://huggingface.co/spaces/Langflow/Langflow?duplicate=true) or [Langflow v1.0 alpha Preview Space](https://huggingface.co/spaces/Langflow/Langflow-Preview?duplicate=true). + +You'll be presented with the following screen: + + + +Name your Space, define the visibility (Public or Private), and click on **Duplicate Space** to start the installation process. When installation is finished, you'll be redirected to the Space's main page to start using Langflow right away! \ No newline at end of file diff --git a/docs/docs/getting-started/quickstart.mdx b/docs/docs/getting-started/quickstart.mdx index f54a07747..774e0c859 100644 --- a/docs/docs/getting-started/quickstart.mdx +++ b/docs/docs/getting-started/quickstart.mdx @@ -15,7 +15,7 @@ This guide demonstrates how to build a basic prompt flow and modify that prompt * [OpenAI API key](https://platform.openai.com) - Langflow v1.0 alpha is also available in [HuggingFace Spaces](https://huggingface.co/spaces/Langflow/Langflow-Preview?duplicate=true). Try it out or follow the instructions [here](./huggingface-spaces) to install it locally. + Langflow v1.0 alpha is also available in [HuggingFace Spaces](https://huggingface.co/spaces/Langflow/Langflow-Preview?duplicate=true). Try it out or follow the instructions [here](./install-langflow##huggingface-spaces) to install it locally. ## Hello World - Basic Prompting diff --git a/docs/sidebars.js b/docs/sidebars.js index b03fb76e8..1bf42c4ea 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -14,9 +14,14 @@ module.exports = { "index", "getting-started/install-langflow", "getting-started/quickstart", - "getting-started/huggingface-spaces", - "getting-started/canvas", - "getting-started/flows-components-collections", + { + type: "category", + label: "Langflow Functionality", + items: [ + "getting-started/canvas", + "getting-started/flows-components-collections", + ], + }, "migration/possible-installation-issues", "getting-started/new-to-llms", ],