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

Documentation update #52

Merged
merged 17 commits into from
May 17, 2024
Merged

Documentation update #52

merged 17 commits into from
May 17, 2024

Conversation

rchan26
Copy link
Collaborator

@rchan26 rchan26 commented May 14, 2024

Also did some small tweaks as I wrote the documentation:

  • Added a fix for the obtain missing jsonl command
  • Applied the get_model_name_identifier function to all model names for any API
  • Simplied quart API to not use the model-name passed - it can't actually do anything anyway besides telling us we're querying from the wrong endpoint. I've adjusted it so it works just like the huggingface text-generation-inference endpoint - it will return the model that is being ran in it's response json. Just like HF TGI API model, we will save this in the "model" key in the response and use this to confirm that the model is truly the model we want

There is one thing outstanding to do which is to add documentation on how to add a new model. I will leave this for another PR. We might want to add other things like a issue template for requesting APIs etc.

Another thing is that there's no documentation set up for the functions and classes. We can leave that for another PR too for a readthedocs set up.

@rchan26 rchan26 marked this pull request as draft May 14, 2024 16:37
@rchan26 rchan26 requested a review from fedenanni May 16, 2024 15:49
@rchan26 rchan26 marked this pull request as ready for review May 16, 2024 15:49
Copy link
Collaborator

@fedenanni fedenanni left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rchan26 ok, done. all looks good to me

@rchan26 rchan26 merged commit b71bd16 into main May 17, 2024
3 checks passed
@rchan26 rchan26 deleted the documentation-update branch May 17, 2024 10:31
rchan26 added a commit that referenced this pull request May 20, 2024
rchan26 added a commit that referenced this pull request May 20, 2024
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

Successfully merging this pull request may close these issues.

Update README and documentation Add docstrings to all functions, methods and classes
2 participants