[API] Documentation for Demo API + Example/Walkthrough
Open
Nobody has claimed this yet.
Priority-P0
Type-documentation
- Dominant language
- Python
- Stars
- 502
- Forks
- 58
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 57
Description
Documentation for Demo API with Example/Walkthrough of developing a demo:
- Demo without input (like T2V) for a model that supports input.
- Add input to the demo and show how to integrate with a model via the Demo API.
- Add to demo
UI- Blocked on #468 - ... [other Demo API features must also be demo'd]
Contributor 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.
Research direction
Start by reviewing the existing Demo API and demo implementation, then check the dependency on issue #468 for the UI portion. Document a no-input demo, adding input, model integration through the Demo API, and the other Demo API features that are in scope; done means the examples and walkthrough cover the agreed feature set.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100