Create documentation showcasing how to use scripts in examples folder
- Dominant language
- Python
- Stars
- 12
- Forks
- 55
- PR merge metrics
- No merged PRs in 30d
Description
## Description
As a user of the library, I want to know how to use the example scripts available in the repository and which script does what, so that I can easily try out `caikit-nlp` and perform experiments
## Discussion
Provide detailed discussion here
## Acceptance Criteria
- [ ] Unit tests cover new/changed code
- [ ] Examples build against new/changed code
- [ ] READMEs are updated
- [ ] Type of [semantic version](https://semver.org/) change is identified
Contributor guide
Research direction
Start by inventorying the scripts in the examples folder and reviewing any existing READMEs to determine how each script is used and what it does. Done means the repository documents how users can run the example scripts and choose one for experiments; the issue does not name specific files or tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100