-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #41 from mayureshagashe2105/main
Update singleton connection class to check SQL server's timeout
- Loading branch information
Showing
2 changed files
with
99 additions
and
99 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,98 +1,98 @@ | ||
| ## Inspiration | ||
| **Techdocs** really started as a passion project due to our indolent nature towards documenting our own codebases. We are currently working as core backend-microservice developers for an open-source organization - [Heritians](https://github.com/Heritians) at our University. | ||
|
|
||
| Here is our story about how **Techdocs** was born: | ||
|
|
||
| 1. Currently, we are the only devs working on the project but now that we have recruited 20+ new students it is inevitable to document our code to increase code readability. | ||
| 2. At the time of recruitment, our codebase already consisted of 6+ directories and 4k+ lines of code. | ||
| 3. For the new recruits, understanding our codebase ASAP is imperative. | ||
| 4. Documenting the code manually is not a possibility because, well, we are lazy and we hate to document. | ||
| 5. As we both are very well-versed with LLMs our thought was, why don't we automate this boring documentation thing once and for all? And there we have it. | ||
|
|
||
| **OUR LAZINESS IS THE SOLE MOTIVATION FOR TECHDOCS** | ||
|
|
||
| ## What it does | ||
| Techdocs is a [PyPI package](https://pypi.org/project/techdocs/) capable of automatically generating documentation for Python codebases via **CLI**. Techdocs generate the docstrings in place by analyzing the structure, logic, and functionality of code by leveraging **Abstract Syntax Tree (AST)** for `.py` files. It leverages the power and efficiency of **Large Language Models (LLMs)** along with carefully crafted API design to accomplish the task. | ||
|
|
||
| ## How we built it | ||
| Techdocs can be broadly classified into 3 major components: | ||
|
|
||
| 1. **Backend/API**: | ||
| This API is where all the magic happens. It acts as a brain for our product. Developed using **FastAPI**, our API is catered to achieve minimum user-perceived latency. Our API hosts **WizardLM-70B** - a fine-tuned version of the **Llama-2** model for downstream tasks like Code Understanding, and Code Generation. | ||
| - Deployment: The API is linked with Huggingface spaces via a simple `.yml` workflow. It then uses the power of **DOCKER** to containerize the API module, hosting it on **Hugginface's servers**. This way, our public endpoints are exposed and our CLI tool can use them however the user intends. | ||
| - LLM Tools Used: The API uses the **WizardLM-70B** model served on **Clarifai's servers**. Integration of Prompt Engineering, user inputs and model inference are done with the help of **Langchain**. | ||
|
|
||
| Deployed API Link: [https://caffeinecrew-techdocs.hf.space/docs](https://caffeinecrew-techdocs.hf.space/docs) | ||
|
|
||
| 2. **CLI/PyPI Package**: | ||
| This is the main interface with which users can interact with our product. The tool is a PyPI package which makes it easier to install and use in any Python project. To prepare the package tools like `build`, `twine`, `setuptools`, and `argparse` have been used. Here are a few things you can do with the CLI tool. | ||
|
|
||
| ```bash | ||
| $ techdocs | ||
|
|
||
| >👋 Hi there! Welcome to techdocs. Here are some cool things you can do: | ||
|
|
||
|
|
||
| 💫 try out a demo with our new GUI 🚀 and explore how to use the CLI: | ||
|
|
||
| ➡️ https://techdocs.streamlit.app/ | ||
|
|
||
| 💫 signup here to get an API key 👤: | ||
|
|
||
| $ techdocs signup -u <username> -p <password> -e <email> | ||
|
|
||
| 💫 use the line below to issue a new API key 🗝️: | ||
|
|
||
| $ techdocs apikey -u <username> -p <password> | ||
|
|
||
| 💫 use the CLI to generate documentation for your project 📚: | ||
|
|
||
| $ techdocs generate -k <api_key> -u <username> -p <password> -d <directory> | ||
| ``` | ||
|
|
||
| PyPI package: [https://pypi.org/project/techdocs/](https://pypi.org/project/techdocs/) | ||
|
|
||
| 3. **Web App**: | ||
| > Note that the web app is only intended as a demo. To unleash the full power of **Techdocs**, please refer to the CLI usage. | ||
|
|
||
| We used Streamlit to create a user-friendly web app that allows users to upload their code block and get the documentation in a proper format. We have mentioned clear instructions on the instructions page. The home page of our app has all the details of our Techdocs projects along with its Architecture. | ||
|
|
||
| ## Challenges we ran into | ||
| 1. API Deployment Issues: | ||
| - Our very first API design consisted of keeping the entire `WizardLM-70B` model locally on Huggingface's servers. However, the size of the model exceeded the free tier available there. Furthermore, inferencing from a model available on a local disk was extremely time-consuming. To get docstrings of a single function it would take a few minutes. | ||
| - To tackle these mentioned issues, we shifted to Clarifai's API for our LLM. As the model is constantly kept on a dedicated server, the inferencing time was **reduced by 90%** from the original approach. Our inference time was **reduced from a few minutes to under 10 seconds**. | ||
| - This step, however, added an external dependency for our API deployment. Before going for Hugginface Spaces, the original plan was to deploy the API on Vercel Cloud. However, we were not able to deploy it on Vercel due to this newly added dependency - the 'Clarifai' package, as it exceeded the free tier resources that Vercel grants. | ||
| - To solve this issue, we decided to sync our GitHub repo to Huggingface Spaces via a `.yml` workflow and then deploy the API there by using our `DOCKERFILE`. Without the docker support from Huggingface Spaces, we could not have deployed our API anywhere! Docker was our saviour. | ||
|
|
||
| 2. CLI development: | ||
| - Unlike the infamous `click` package for building CLIs, the package we used `argparse`, does not provide a built-in way to create subcommands. Adding subcommands by adding sub-parsers and binding appropriate function definitions was a nightmare. But we aced it eventually! | ||
|
|
||
|
|
||
| ## Accomplishments that we're proud of | ||
| 1. Firstly, all the documentation you see in this project is created by using **Techdocs**. No code documentation is done manually :) | ||
| 2. We have developed a PyPI package so contributors all around the world can contribute and make this product better. We strongly believe, in the power of open-source projects! | ||
|
|
||
| ## What we learned | ||
| 1. The use of Langchain was crucial here. This open-source tool has so much potential and is very handy in developing LLM products. It is cool! | ||
| 2. DOCKER images are way better than using other deployment platforms. | ||
| 3. This was the very first project where we actually used docker to deploy our product. | ||
| 4. Designing UI is a heck of a task. | ||
|
|
||
| ## What's next for Techdocs | ||
| 1. Currently, Techdocs can only generate documentation for Python programming language. Our plan is to expand our product to a spectrum of popular programming languages to help developers across the globe with documentation tasks. | ||
| - We plan to hire experts from different programming languages so that we can extend the support and build native packages for those languages. Being final-year undergrad students, we are looking for decent funding so we can achieve this task. | ||
| 2. As of now, our product suffers majorly in terms of privacy and integrity. As we have mentioned earlier, we are using a third-party `Clarifai` package for hosting our LLM. This creates a big question about user code integrity and privacy. | ||
| - To cater to this issue, we are constantly exploring new quantized and light versions of possible LLMs that we can employ for this task. This will eliminate the need for third-party APIs. | ||
| - We plan to integrate such lightweight models into our PyPI package itself so that none of the user's code will be sent anywhere, and all the documentation generation will take place on the user's device itself. | ||
|
|
||
| ## Techstack 🧑💻 | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
| ## Inspiration | ||
| **Techdocs** really started as a passion project due to our indolent nature towards documenting our own codebases. We are currently working as core backend-microservice developers for an open-source organization - [Heritians](https://github.com/Heritians) at our University. | ||
|
|
||
| Here is our story about how **Techdocs** was born: | ||
|
|
||
| 1. Currently, we are the only devs working on the project but now that we have recruited 20+ new students it is inevitable to document our code to increase code readability. | ||
| 2. At the time of recruitment, our codebase already consisted of 6+ directories and 4k+ lines of code. | ||
| 3. For the new recruits, understanding our codebase ASAP is imperative. | ||
| 4. Documenting the code manually is not a possibility because, well, we are lazy and we hate to document. | ||
| 5. As we both are very well-versed with LLMs our thought was, why don't we automate this boring documentation thing once and for all? And there we have it. | ||
|
|
||
| **OUR LAZINESS IS THE SOLE MOTIVATION FOR TECHDOCS** | ||
|
|
||
| ## What it does | ||
| Techdocs is a [PyPI package](https://pypi.org/project/techdocs/) capable of automatically generating documentation for Python codebases via **CLI**. Techdocs generate the docstrings in place by analyzing the structure, logic, and functionality of code by leveraging **Abstract Syntax Tree (AST)** for `.py` files. It leverages the power and efficiency of **Large Language Models (LLMs)** along with carefully crafted API design to accomplish the task. | ||
|
|
||
| ## How we built it | ||
| Techdocs can be broadly classified into 3 major components: | ||
|
|
||
| 1. **Backend/API**: | ||
| This API is where all the magic happens. It acts as a brain for our product. Developed using **FastAPI**, our API is catered to achieve minimum user-perceived latency. Our API hosts **WizardLM-70B** - a fine-tuned version of the **Llama-2** model for downstream tasks like Code Understanding, and Code Generation. | ||
| - Deployment: The API is linked with Huggingface spaces via a simple `.yml` workflow. It then uses the power of **DOCKER** to containerize the API module, hosting it on **Hugginface's servers**. This way, our public endpoints are exposed and our CLI tool can use them however the user intends. | ||
| - LLM Tools Used: The API uses the **WizardLM-70B** model served on **Clarifai's servers**. Integration of Prompt Engineering, user inputs and model inference are done with the help of **Langchain**. | ||
|
|
||
| Deployed API Link: [https://caffeinecrew-techdocs.hf.space/docs](https://caffeinecrew-techdocs.hf.space/docs) | ||
|
|
||
| 2. **CLI/PyPI Package**: | ||
| This is the main interface with which users can interact with our product. The tool is a PyPI package which makes it easier to install and use in any Python project. To prepare the package tools like `build`, `twine`, `setuptools`, and `argparse` have been used. Here are a few things you can do with the CLI tool. | ||
|
|
||
| ```bash | ||
| $ techdocs | ||
|
|
||
| >👋 Hi there! Welcome to techdocs. Here are some cool things you can do: | ||
|
|
||
|
|
||
| 💫 try out a demo with our new GUI 🚀 and explore how to use the CLI: | ||
|
|
||
| ➡️ https://techdocs.streamlit.app/ | ||
|
|
||
| 💫 signup here to get an API key 👤: | ||
|
|
||
| $ techdocs signup -u <username> -p <password> -e <email> | ||
|
|
||
| 💫 use the line below to issue a new API key 🗝️: | ||
|
|
||
| $ techdocs apikey -u <username> -p <password> | ||
|
|
||
| 💫 use the CLI to generate documentation for your project 📚: | ||
|
|
||
| $ techdocs generate -k <api_key> -u <username> -p <password> -d <directory> | ||
| ``` | ||
|
|
||
| PyPI package: [https://pypi.org/project/techdocs/](https://pypi.org/project/techdocs/) | ||
|
|
||
| 3. **Web App**: | ||
| > Note that the web app is only intended as a demo. To unleash the full power of **Techdocs**, please refer to the CLI usage. | ||
|
|
||
| We used Streamlit to create a user-friendly web app that allows users to upload their code block and get the documentation in a proper format. We have mentioned clear instructions on the instructions page. The home page of our app has all the details of our Techdocs projects along with its Architecture. | ||
|
|
||
| ## Challenges we ran into | ||
| 1. API Deployment Issues: | ||
| - Our very first API design consisted of keeping the entire `WizardLM-70B` model locally on Huggingface's servers. However, the size of the model exceeded the free tier available there. Furthermore, inferencing from a model available on a local disk was extremely time-consuming. To get docstrings of a single function it would take a few minutes. | ||
| - To tackle these mentioned issues, we shifted to Clarifai's API for our LLM. As the model is constantly kept on a dedicated server, the inferencing time was **reduced by 90%** from the original approach. Our inference time was **reduced from a few minutes to under 10 seconds**. | ||
| - This step, however, added an external dependency for our API deployment. Before going for Hugginface Spaces, the original plan was to deploy the API on Vercel Cloud. However, we were not able to deploy it on Vercel due to this newly added dependency - the 'Clarifai' package, as it exceeded the free tier resources that Vercel grants. | ||
| - To solve this issue, we decided to sync our GitHub repo to Huggingface Spaces via a `.yml` workflow and then deploy the API there by using our `DOCKERFILE`. Without the docker support from Huggingface Spaces, we could not have deployed our API anywhere! Docker was our saviour. | ||
|
|
||
| 2. CLI development: | ||
| - Unlike the infamous `click` package for building CLIs, the package we used `argparse`, does not provide a built-in way to create subcommands. Adding subcommands by adding sub-parsers and binding appropriate function definitions was a nightmare. But we aced it eventually! | ||
|
|
||
|
|
||
| ## Accomplishments that we're proud of | ||
| 1. Firstly, all the documentation you see in this project is created by using **Techdocs**. No code documentation is done manually :) | ||
| 2. We have developed a PyPI package so contributors all around the world can contribute and make this product better. We strongly believe, in the power of open-source projects! | ||
|
|
||
| ## What we learned | ||
| 1. The use of Langchain was crucial here. This open-source tool has so much potential and is very handy in developing LLM products. It is cool! | ||
| 2. DOCKER images are way better than using other deployment platforms. | ||
| 3. This was the very first project where we actually used docker to deploy our product. | ||
| 4. Designing UI is a heck of a task. | ||
|
|
||
| ## What's next for Techdocs | ||
| 1. Currently, Techdocs can only generate documentation for Python programming language. Our plan is to expand our product to a spectrum of popular programming languages to help developers across the globe with documentation tasks. | ||
| - We plan to hire experts from different programming languages so that we can extend the support and build native packages for those languages. Being final-year undergrad students, we are looking for decent funding so we can achieve this task. | ||
| 2. As of now, our product suffers majorly in terms of privacy and integrity. As we have mentioned earlier, we are using a third-party `Clarifai` package for hosting our LLM. This creates a big question about user code integrity and privacy. | ||
| - To cater to this issue, we are constantly exploring new quantized and light versions of possible LLMs that we can employ for this task. This will eliminate the need for third-party APIs. | ||
| - We plan to integrate such lightweight models into our PyPI package itself so that none of the user's code will be sent anywhere, and all the documentation generation will take place on the user's device itself. | ||
|
|
||
| ## Techstack 🧑💻 | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  |