wpilib-copilot

Your WPILib Pair Programmer

https://github.com/team3256/wpilib-copilot

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (10.2%) to scientific vocabulary

Last synced: 9 months ago · JSON representation ·

Repository

Your WPILib Pair Programmer

Basic Info

Host: GitHub
Owner: Team3256
License: gpl-3.0
Language: Python
Default Branch: main
Homepage:
Size: 270 KB

Statistics

Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Releases: 0

Created about 3 years ago · Last pushed about 3 years ago

Metadata Files

Readme License Citation

README.md

WPILib-Copilot

This repo is an implementation of a locally hosted chatbot specifically focused on question answering over the WPILib documentation. Built with LangChain and FastAPI.

The app leverages LangChain's streaming support and async API to update the page in real time for multiple users.

✅ Running locally

Install dependencies: pip install -r requirements.txt
Run ingest.sh to ingest WPILib docs data into the vectorstore (only needs to be done once).
Run the app: make start
1. To enable tracing, make sure langchain-server is running locally and pass tracing=True to get_chain in main.py. You can find more documentation here.
Open localhost:9000 in your browser.

📚 Technical description

There are two components: ingestion and question-answering.

Ingestion has the following steps:

Pull html from documentation site
Load html with LangChain's ReadTheDocs Loader
Split documents with LangChain's TextSplitter
Create a vectorstore of embeddings, using LangChain's vectorstore wrapper (with OpenAI's embeddings and FAISS vectorstore).

Question-Answering has the following steps, all handled by ConversationalRetrievalChain:

Given the chat history and new user input, determine what a standalone question would be (using ChatGPT).
Given that standalone question, look up relevant documents from the vectorstore.
Pass the standalone question and relevant documents to ChatGPT to generate a final answer.

Owner

Name: WarriorBorgs 3256
Login: Team3256
Kind: organization
Email: robotics@warriorlife.net
Location: San Jose, California

Website: vcrobotics.net
Twitter: warriorborgs
Repositories: 50
Profile: https://github.com/Team3256

FRC team out of Valley Christian Schools in San Jose, California

Citation (CITATION.cff)

cff-version: 1.2.0
title: WPILib Copilot
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Akhil
    family-names: Datla
repository-code: 'https://github.com/Team3256/WPILib-Copilot'
keywords:
  - WPILib
  - LangChain
  - FastAPI
  - Artificial Intelligence
  - Machine Learning
license: GPL-3.0
preferred-citation:
    type: software
    authors:
      - given-names: Harrison
        family-names: Chase
    title: "chat-langchain"
    date-released: "2023-01-16"
    repository-code: "https://github.com/hwchase17/chat-langchain"

GitHub Events

Total

Last Year

Issues and Pull Requests

Last synced: about 1 year ago

All Time

Total issues: 0
Total pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Total issue authors: 0
Total pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science