ProjectTech4DevAI / ProjectTech4DevAI/kaapi-guardrails
Documentation: mention in docs that spacey model uploads
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 5
- Forks
- 3
- Avg merge
- 9d 13h
- Merged PRs (30d)
- 2
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.
Contributor guide
No contributing guide indexed for this repository
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.
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.
Assessment
- Tech stack
- fastapi, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100