Documentation: mention in docs that spacey model uploads
Maintainers usually reply within 10 days
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 55/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
Start with the documentation for the FastAPI server and the first-run behavior described in the issue. Confirm where the NLP model upload occurs and document that it happens on the first run and why; done when a new user can find and understand this behavior.
Written by the indexing model from the issue text.
Description
Describe the current behavior
When a completely new system hits the guardrail backend service for the first time, an NLP model uploads and after that only request processing starts, this fact is not mentioned anywhere in the documentation which causes confusion to someone hitting the service for the first time.
Describe the enhancement you'd like
It should be clearly stated in the documentation that when you run the fastapi server for the first time a spacey nlp model will be uploaded, and the reason of why it will be uploaded should also be stated.
- Dominant language
- Python
- Stars
- 5
- Forks
- 4
- Avg merge
- 9d 13h
- Merged PRs (30d)
- 2
Getting set up
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- No contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from ProjectTech4DevAI/kaapi-guardrails
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
ProjectTech4DevAI/kaapi-guardrails#94 ·
Maintainers usually reply within 10 days
-
Difficulty 1/5 Under an hour Newbie friendliness 65/100
ProjectTech4DevAI/kaapi-guardrails#23 ·
Maintainers usually reply within 10 days
-
Callback Enhancement: Include intermediate responsesPossibly taken @Prajna1999 claimed this 22 days ago. Open
ProjectTech4DevAI/kaapi-guardrails#158 · 1 assignee ·
Maintainers usually reply within 10 days
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
ProjectTech4DevAI/kaapi-guardrails#144 ·
Maintainers usually reply within 10 days
-
Difficulty 3/5 1-2 days Newbie friendliness 55/100
ProjectTech4DevAI/kaapi-guardrails#137 ·
Maintainers usually reply within 10 days
All issues in ProjectTech4DevAI/kaapi-guardrails
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
BasedHardware/omi#20271 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 92/100
openai/openai-cookbook#3153 ·
Maintainers usually reply within 1 day
-
cvss-severity:high devguard l3montree-cybersecurity/devguard/devguard pkg:golang/github.com/l3montree-dev/devguard risk:low state:open
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
l3montree-dev/devguard#3146 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
bug confirmed issue
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
open-webui/open-webui#31849 · 2 comments ·
Maintainers usually reply within 1 day