Skip to content

Latest commit

 

History

History
169 lines (113 loc) · 7.49 KB

README.md

File metadata and controls

169 lines (113 loc) · 7.49 KB
Raw
SambaNova logo

SambaNova scribe

Questions? Just message us on Discord Discord or create an issue in GitHub. We're happy to help live!

Table of Contents:

Overview

This AI Starter Kit is a simple example of a audio transcription and processing workflow. You send your audio file or a youtube link to app and the audio will be send to the SambaNova platform, and get the transcription and the bullet point summary of the PROVIDED audio.

This sample is ready-to-use. We provide:

  • Instructions for setup with SambaNova Cloud.
  • Instructions for running the application as is.
  • Instructions for customizing the application.

Before you begin

You have to set up your environment before you can run or customize the starter kit.

Clone this repository

Clone the starter kit repo.

git clone https://github.com/sambanova/ai-starter-kit.git

Install System Dependencies

this kit requires you to have installed in your system ffmpeg:

  • On macOS, you can manually install them using Homebrew:
    brew install ffmpeg
  1. On Linux (Ubuntu/Debian), you can install them manually:
    sudo apt-get update && sudo apt-get install -y ffmpeg
  1. On Windows, you may need to install these dependencies manually from the ffmpeg site and ensure they are in your system PATH.

Set up the models, environment variables and config file

Set up the transcription model

The next step is to set up your environment variables to use one of the transcription models available from SambaNova. You can obtain a free API key through SambaNova Cloud.

  • SambaNova Cloud: To set up your environment variables.

For more information and to obtain your API key, visit the SambaNova Cloud webpage.

To integrate SambaNova Cloud Transcription models with this AI starter kit, update the API information by configuring the environment variables in the ai-starter-kit/.env file:

  • Create the .env file at ai-starter-kit/.env if the file does not exist.
  • Enter the transcription SambaNova Cloud API url and key in the .env file, for example:
TRANSCRIPTION_BASE_URL = "https://api.sambanova.ai/v1"
TRANSCRIPTION_API_KEY = "456789abcdef0123456789abcdef0123"

Set up the generative model

The next step is to set up your environment variables to use one of the inference models available from SambaNova. You can obtain a free API key through SambaNova Cloud. Alternatively, if you are a current SambaNova customer, you can deploy your models using SambaStudio.

  • SambaNova Cloud (Option 1): Follow the instructions here to set up your environment variables. Then, in the config file, set the llm type variable to "sncloud" and set the select_expert config depending on the model you want to use.

Deploy the starter kit GUI

We recommend that you run the starter kit in a virtual environment or use a container. We also recommend using Python >= 3.10 and < 3.12.

  1. Install and update pip.
    cd ai-starter-kit/sambanova_scribe
    python3 -m venv sambanova_scribe_env
    source sambanova_scribe_env/bin/activate
    pip  install  -r  requirements.txt
  1. Run the following command:
    streamlit run streamlit/app.py --browser.gatherUsageStats false

After deploying the starter kit you see the following user interface:

capture of sambanova scribe demo

Use the starter kit

After you've deployed the GUI, you can use the starter kit. Follow these steps:

  1. Depending if you have set your env variables you will be prompted or not to set them in the set up bar.

  2. In the main panel select the input method either a youtube link or a file.

    Audios should be mp3, mp4 or wav format Either from youtube download or audio file can not exceed 25MB

  3. Click on the Transcribe button this will download the youtube audio or upload your file and generate the transcription of the audio

  4. Click on the create summary button to get a bullet point summary of the recording

Customizing the starter kit

You can further customize the starter kit based on the use case.

Transcription params

The transcription parameters can be customized in the config.yaml file, the the audio_model section you can change the model you want to use to transcribe, the temperature and the language.

Generation model parameters

The llm parameters can be customized in the config.yaml file, the the llm section you can change the model you want to use in select_expert parameter, also parameters like temperature or max_tokens_to_generate

Experiment with prompt engineering

Prompting has a significant effect on the quality of LLM responses. Prompts can be further customized to improve the overall quality of the responses from the LLMs. For example, in this starter kit, the following prompt template was used to generate a bullet point summary from the LLM, where text is the transcription of the audio, and num the number of bullet points to generate.

template: |
    <|begin_of_text|><|start_header_id|>system<|end_header_id|> You are a helpful assistant powered by Sambanova's AI chip accelerator, designed to assist users to optimize their workflow. 
    Use the following transcription of an audio ang generate {num} bullet points that summarize what is covered in the audio.
    Maintain a professional yet conversational tone. Do not use images or emojis in your answer.
    Prioritize accuracy and only provide information directly supported by the text transcription. <|eot_id|><|start_header_id|>user<|end_header_id|>
    Transcription: {text} 
    \n ------- \n
    Answer: <|eot_id|><|start_header_id|>assistant<|end_header_id|>

You can make modifications to the prompt template in the following file:

    file: prompts/summary.yaml

Third-party tools and data sources

All the packages/tools are listed in the requirements.txt file in the project directory.