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] Using non-OpenAI models #2076

Merged
merged 16 commits into from
Mar 20, 2024
Merged

[Documentation] Using non-OpenAI models #2076

merged 16 commits into from
Mar 20, 2024

Conversation

marklysze
Copy link
Collaborator

@marklysze marklysze commented Mar 19, 2024

As there's a lot of interest in running AutoGen with non-OpenAI models and there's a drive to add it to the documentation (#1994), here's a start to the documentation for using non-OpenAI models with cloud and local proxy servers.

There's a new menu item under Docs > Topics called Using Non-OpenAI Models.

Under this are the start of the documentation for using non-OpenAI models, with three pages:

  1. Non-OpenAI Models (an introduction to using cloud and local proxy servers)
  2. Cloud-based Proxy Servers (An example of a cloud proxy server, together.ai)
  3. Locally Run Proxy Servers (An example of LiteLLM+Ollama)

I'll add vLLM to the locally run proxy servers and am also looking to add huggingface.co to the cloud-based (if I can get a working example).

It would be great for others to add examples for cloud-based and locally run proxy servers.

Adding custom model classes would also be a good additional page and examples.

Incorporating (#2044 - LM Studio example) by @ekzhu is necessary, too, and that has a matching folder structure.

Related issue number

1994 - [Documentation] Topic Category for AutoGen + Non-OpenAI Models is the driver for this PR.

2044 - Add LM Studio Example in Topics to be incorporated / merged.

Checks

UPDATE

The current documentation structure is now:
Docs > Topics > Using Non-OpenAI Models

Under this is an introduction page and then individual pages for cloud-based and local proxy servers.

@marklysze marklysze changed the title Documentation addition: Using non-OpenAI models [Documentation]: Using non-OpenAI models Mar 19, 2024
@marklysze marklysze changed the title [Documentation]: Using non-OpenAI models [Documentation] Using non-OpenAI models Mar 19, 2024
@codecov-commenter
Copy link

codecov-commenter commented Mar 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.90%. Comparing base (6d2c923) to head (b3ccbc7).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2076      +/-   ##
==========================================
+ Coverage   36.88%   36.90%   +0.01%     
==========================================
  Files          68       68              
  Lines        7062     7061       -1     
  Branches     1540     1541       +1     
==========================================
+ Hits         2605     2606       +1     
+ Misses       4228     4225       -3     
- Partials      229      230       +1     
Flag Coverage Δ
unittests 36.90% <ø> (+0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@ekzhu ekzhu 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 PR! My comments are mostly about organizing the content into smaller parts for easier navigation and better indexibiity.

@ekzhu
Copy link
Collaborator

ekzhu commented Mar 20, 2024

Thanks! To run pre-commit formatting check locally, you can do:

pre-commit run --all-files

@ekzhu ekzhu enabled auto-merge March 20, 2024 20:11
@ekzhu ekzhu added this pull request to the merge queue Mar 20, 2024
Merged via the queue into microsoft:main with commit 7739632 Mar 20, 2024
24 checks passed
@marklysze marklysze deleted the NonOpenAILLMDocs branch March 21, 2024 23:51
@marklysze marklysze restored the NonOpenAILLMDocs branch March 22, 2024 00:04
@marklysze marklysze deleted the NonOpenAILLMDocs branch March 22, 2024 00:04
whiskyboy pushed a commit to whiskyboy/autogen that referenced this pull request Apr 17, 2024
* Addition of Non-OpenAI LLM section and main doc page

* Continued writing...

* Continued writing - cloud-based proxy servers

* Folder renamed

* Further writing

* together.ai example added

* Local proxy server added, diagram added, tidy up

* Added vLLM to local proxy servers documentation

* As per @ekzhu's feedback, individual pages and tidy up

* Added reference to LM Studio and renamed file

* Fixed incorrect huggingface.co link

* Run pre-commit checks, added LM Studio redirect

---------

Co-authored-by: Eric Zhu <ekzhu@users.noreply.github.com>
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.

3 participants