Note to first-time contributors: Please open a discussion post in Discussions and describe your changes before submitting a pull request.
Before submitting, make sure you've checked the following:
Target branch: Please verify that the pull request targets the dev branch.
Description: Provide a concise description of the changes made in this pull request.
Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.
Documentation: Have you updated relevant documentation Open WebUI Docs, or other documentation sources?
Dependencies: Are there any new dependencies? Have you updated the dependency versions in the documentation?
Testing: Have you written and run sufficient tests for validating the changes?
Code review: Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
Prefix: To cleary categorize this pull request, prefix the pull request title, using one of the following:
BREAKING CHANGE: Significant changes that may affect compatibility
build: Changes that affect the build system or external dependencies
ci: Changes to our continuous integration processes or workflows
chore: Refactor, cleanup, or other non-functional code changes
docs: Documentation update or addition
feat: Introduces a new feature or enhancement to the codebase
fix: Bug fix or error correction
i18n: Internationalization or localization changes
perf: Performance improvement
refactor: Code restructuring for better maintainability, readability, or scalability
style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.)
test: Adding missing tests or correcting existing tests
WIP: Work in progress, a temporary label for incomplete or ongoing work
Changelog Entry
Description
Delay imports of faster_whisper and sentence_transformers until they are needed. In the event that local STT or RAG is not used, this reduces startup memory usage when used with non-local embeddings from ~400MB to ~160MB.
🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.
## 📋 Pull Request Information
**Original PR:** https://github.com/open-webui/open-webui/pull/3558
**Author:** [@cheahjs](https://github.com/cheahjs)
**Created:** 7/1/2024
**Status:** ✅ Merged
**Merged:** 7/1/2024
**Merged by:** [@tjbck](https://github.com/tjbck)
**Base:** `dev` ← **Head:** `refac/reduce-startup-mem-usage`
---
### 📝 Commits (2)
- [`17c6843`](https://github.com/open-webui/open-webui/commit/17c684369e9a1432ce21037d8f0975cfd753457e) refac: lazily load faster_whisper to reduce start up memory usage
- [`a48ac6a`](https://github.com/open-webui/open-webui/commit/a48ac6a20973d0d433e49ff5176e7d0704d84d14) refac: lazily load sentence_transformers to reduce start up memory usage
### 📊 Changes
**4 files changed** (+8 additions, -6 deletions)
<details>
<summary>View changed files</summary>
📝 `backend/apps/audio/main.py` (+2 -1)
📝 `backend/apps/images/main.py` (+0 -1)
📝 `backend/apps/rag/main.py` (+4 -2)
📝 `backend/apps/rag/utils.py` (+2 -2)
</details>
### 📄 Description
# Pull Request Checklist
### Note to first-time contributors: Please open a discussion post in [Discussions](https://github.com/open-webui/open-webui/discussions) and describe your changes before submitting a pull request.
**Before submitting, make sure you've checked the following:**
- [x] **Target branch:** Please verify that the pull request targets the `dev` branch.
- [x] **Description:** Provide a concise description of the changes made in this pull request.
- [ ] **Changelog:** Ensure a changelog entry following the format of [Keep a Changelog](https://keepachangelog.com/) is added at the bottom of the PR description.
- [ ] **Documentation:** Have you updated relevant documentation [Open WebUI Docs](https://github.com/open-webui/docs), or other documentation sources?
- [ ] **Dependencies:** Are there any new dependencies? Have you updated the dependency versions in the documentation?
- [ ] **Testing:** Have you written and run sufficient tests for validating the changes?
- [ ] **Code review:** Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
- [x] **Prefix:** To cleary categorize this pull request, prefix the pull request title, using one of the following:
- **BREAKING CHANGE**: Significant changes that may affect compatibility
- **build**: Changes that affect the build system or external dependencies
- **ci**: Changes to our continuous integration processes or workflows
- **chore**: Refactor, cleanup, or other non-functional code changes
- **docs**: Documentation update or addition
- **feat**: Introduces a new feature or enhancement to the codebase
- **fix**: Bug fix or error correction
- **i18n**: Internationalization or localization changes
- **perf**: Performance improvement
- **refactor**: Code restructuring for better maintainability, readability, or scalability
- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.)
- **test**: Adding missing tests or correcting existing tests
- **WIP**: Work in progress, a temporary label for incomplete or ongoing work
# Changelog Entry
### Description
Delay imports of `faster_whisper` and `sentence_transformers` until they are needed. In the event that local STT or RAG is not used, this reduces startup memory usage when used with non-local embeddings from ~400MB to ~160MB.
Memory flamegraphs:
* Stock, OpenAI embeddings (432MB): https://yolo-bucket.jscheah.me/memray-flamegraph-uvicorn.50262.html
* Lazily loaded `faster_whisper` (388MB): https://yolo-bucket.jscheah.me/memray-flamegraph-uvicorn.67752.html
* Lazily loaded `faster_whisper` and `sentence_transformers` (163MB): https://yolo-bucket.jscheah.me/memray-flamegraph-uvicorn.69138.html
---
<sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
📋 Pull Request Information
Original PR: https://github.com/open-webui/open-webui/pull/3558
Author: @cheahjs
Created: 7/1/2024
Status: ✅ Merged
Merged: 7/1/2024
Merged by: @tjbck
Base:
dev← Head:refac/reduce-startup-mem-usage📝 Commits (2)
17c6843refac: lazily load faster_whisper to reduce start up memory usagea48ac6arefac: lazily load sentence_transformers to reduce start up memory usage📊 Changes
4 files changed (+8 additions, -6 deletions)
View changed files
📝
backend/apps/audio/main.py(+2 -1)📝
backend/apps/images/main.py(+0 -1)📝
backend/apps/rag/main.py(+4 -2)📝
backend/apps/rag/utils.py(+2 -2)📄 Description
Pull Request Checklist
Note to first-time contributors: Please open a discussion post in Discussions and describe your changes before submitting a pull request.
Before submitting, make sure you've checked the following:
devbranch.Changelog Entry
Description
Delay imports of
faster_whisperandsentence_transformersuntil they are needed. In the event that local STT or RAG is not used, this reduces startup memory usage when used with non-local embeddings from ~400MB to ~160MB.Memory flamegraphs:
faster_whisper(388MB): https://yolo-bucket.jscheah.me/memray-flamegraph-uvicorn.67752.htmlfaster_whisperandsentence_transformers(163MB): https://yolo-bucket.jscheah.me/memray-flamegraph-uvicorn.69138.html🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.