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

Update docs on how to interact with local LLM #1128

Merged
merged 22 commits into from
Jul 21, 2023
Merged

Conversation

LeoLjl
Copy link
Collaborator

@LeoLjl LeoLjl commented Jul 14, 2023

Why are these changes needed?

Specifying how to initiate an endpoint and interact with local LLMs using flaml.autogen is needed.

Related issue number

microsoft/autogen#15 #1037

Checks

Copy link
Contributor

@sonichi sonichi left a comment

Choose a reason for hiding this comment

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

Thanks for the detailed documentation. I have a few questions.

website/blog/2023-07-14-Local-LLMs/index.mdx Outdated Show resolved Hide resolved
website/blog/2023-07-14-Local-LLMs/index.mdx Outdated Show resolved Hide resolved
website/blog/2023-07-14-Local-LLMs/index.mdx Outdated Show resolved Hide resolved
website/docs/Use-Cases/Auto-Generation.md Outdated Show resolved Hide resolved
website/blog/2023-07-14-Local-LLMs/index.mdx Show resolved Hide resolved
@LeoLjl
Copy link
Collaborator Author

LeoLjl commented Jul 15, 2023

@microsoft-github-policy-service agree

Copy link
Contributor

@sonichi sonichi left a comment

Choose a reason for hiding this comment

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

Please follow https://microsoft.github.io/FLAML/docs/Contribute#pre-commit to pass the code-formatting check.

website/blog/2023-07-14-Local-LLMs/index.mdx Show resolved Hide resolved
website/blog/2023-07-14-Local-LLMs/index.mdx Outdated Show resolved Hide resolved
website/blog/2023-07-14-Local-LLMs/index.mdx Outdated Show resolved Hide resolved
@LeoLjl LeoLjl requested a review from sonichi July 16, 2023 03:32
Copy link
Contributor

@sonichi sonichi left a comment

Choose a reason for hiding this comment

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

Looks good to me. You can add subtasks for TODOs: register_chat_model and easier endpoint spinup process.

Could you compile the website locally to verify the format is good? Follow: https://microsoft.github.io/FLAML/docs/Contribute#documentation
Also, if you don't have a figure for the blogpost, you can simply put a "filename.md" under "blog/" instead of using "folder_name/index.mdx". The ".md" file can be easily previewed in vscode. See https://docusaurus.io/docs/blog#adding-posts

website/blog/2023-07-14-Local-LLMs/index.mdx Show resolved Hide resolved
@LeoLjl
Copy link
Collaborator Author

LeoLjl commented Jul 17, 2023

Could you compile the website locally to verify the format is good? Follow: https://microsoft.github.io/FLAML/docs/Contribute#documentation Also, if you don't have a figure for the blogpost, you can simply put a "filename.md" under "blog/" instead of using "folder_name/index.mdx". The ".md" file can be easily previewed in vscode. See https://docusaurus.io/docs/blog#adding-posts

I complied the website, the format is good. I see that other blog posts are using the folder/index.mdx, for consistency I decide to retain this file layout.

Copy link
Contributor

@sonichi sonichi left a comment

Choose a reason for hiding this comment

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

In future, consider using a single .md file for simple posts without auxiliary files. @qingyun-wu

@sonichi sonichi self-assigned this Jul 17, 2023
@sonichi sonichi added the documentation Improvements or additions to documentation label Jul 17, 2023
@sonichi sonichi added this to the Upgrade of autogen milestone Jul 17, 2023
@sonichi sonichi added this pull request to the merge queue Jul 17, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jul 17, 2023
@sonichi sonichi added this pull request to the merge queue Jul 18, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jul 18, 2023
@sonichi sonichi self-requested a review July 18, 2023 03:43
Copy link
Contributor

@sonichi sonichi left a comment

Choose a reason for hiding this comment

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

I requested a change after seeing @JieyuZ2 's comment.

@sonichi sonichi enabled auto-merge July 18, 2023 21:47
@sonichi sonichi added this pull request to the merge queue Jul 21, 2023
Merged via the queue into microsoft:main with commit 559fcb4 Jul 21, 2023
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
3 participants