sokrypton / sokrypton/ColabFold
Documentation for --host-url
Open
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 2.9k
- Forks
- 747
- PR merge metrics
- No merged PRs in 30d
Description
It'd be highly appreciated if there was documentation on the specifications of the --host-url and how to create our own!
I know prior responses have said to simply run colabfold_search and use the resulting .a3m file, but it'd be far more streamlined to set up our own API.
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 --host-url behavior and the colabfold_search workflow mentioned in the issue. Document the option's specifications and how to create a compatible API, including how its output relates to the resulting .a3m file; done when users can set up and use their own endpoint without relying on prior responses.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, cli, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100