Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation #14

Open
aaronsantiago opened this issue Oct 22, 2022 · 2 comments
Open

Improve documentation #14

aaronsantiago opened this issue Oct 22, 2022 · 2 comments

Comments

@aaronsantiago
Copy link

There is a lot going on in this repo and a couple things I've tripped on trying to get working for myself:

  • What are the valid parameters for the server arguments, and what do they do?
  • How does one use locally downloaded models instead of the ones hosted on Huggingface?
@hafriedlander
Copy link
Owner

I think documenting engines.yaml is the most pressing, the server arguments do have some documentation when you use --help (although admittedly not much). There's an update coming soon that will significantly increase complexity of engines.yaml too.

Once that's up it'd be great if someone volunteered and had a first stab. Otherwise I'll get to it eventually.

@hafriedlander
Copy link
Owner

Just updating that the new engines.yaml includes a lot more documentation as comments. Hopefully it's a bit improved now (although I'll leave this open as there's still plenty of room for improvement).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants