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

Add Docs for Azure OpenAI fine-tuning #552

Merged
merged 9 commits into from
Jan 15, 2024
Merged

Add Docs for Azure OpenAI fine-tuning #552

merged 9 commits into from
Jan 15, 2024

Conversation

ash0ts
Copy link
Contributor

@ash0ts ash0ts commented Jan 8, 2024

Description

What does the pull request do? If it fixes a bug or resolves a feature request, be sure to link to that issue.

Ticket

Does this PR fix an existing issue? If yes, provide a link to the ticket here:

Checklist

Check if your PR fulfills the following requirements. Put an X in the boxes that apply.

  • Files I edited were previewed on my local development server with yarn start. My changes did not break the local preview.
  • Build (yarn docusaurus build) was run locally and successfully without errors or warnings.
  • I merged the latest changes from main into my feature branch before submitting this PR.

@ash0ts ash0ts requested a review from a team as a code owner January 8, 2024 22:22
@ash0ts
Copy link
Contributor Author

ash0ts commented Jan 8, 2024

@ngrayluna How do I get this new docs page to show up on the sidebar? It didn't show up when I ran it locally but the page rendered when directly typing in the URL

@ash0ts ash0ts marked this pull request as draft January 8, 2024 22:24
@ngrayluna
Copy link
Contributor

Ah. Yes, you'll want to add a new line to the sidebar.js file as well. :)
Screen Shot 2024-01-09 at 10 47 24 AM

@ash0ts ash0ts marked this pull request as ready for review January 10, 2024 14:20
@ash0ts
Copy link
Contributor Author

ash0ts commented Jan 10, 2024

Thanks @ngrayluna! Ready for review :)

@ash0ts
Copy link
Contributor Author

ash0ts commented Jan 10, 2024

E100 [vocab] Runtime error

'config/vocabularies/Docs' directory does not exist

Not sure what this is/where this error comes from

@morganmcg1
Copy link
Member

@ash0ts one nit, can you re-naming the files to lead with "azure...", we should consider this an Azure service, not a OpenAi service. There'll likely be a Azure ML section coming at some point too, so setting a good precedent here would be good

@morganmcg1
Copy link
Member

Looking at this, lets just make this page more like a "diff" of the OpenAI page: https://docs.wandb.ai/guides/integrations/openai

Assuming nothing about the api is different, just show people the changes needed for W&B fine-tuning with Azure vs OpenAI. And direct people towards the OpenAI for everything else that isn't different. That way we only have to maintain 1 page when there are openai api updates etc.

Copy link
Member

@morganmcg1 morganmcg1 left a comment

Choose a reason for hiding this comment

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

Lets re-write this to just be a short "diff" page of Azure OpenAI vs OpenAI. Let more detail in the comment

docs/guides/integrations/other/openai-azure-fine-tuning.md Outdated Show resolved Hide resolved
@ash0ts
Copy link
Contributor Author

ash0ts commented Jan 11, 2024

Looking at this, lets just make this page more like a "diff" of the OpenAI page: https://docs.wandb.ai/guides/integrations/openai

Assuming nothing about the api is different, just show people the changes needed for W&B fine-tuning with Azure vs OpenAI. And direct people towards the OpenAI for everything else that isn't different. That way we only have to maintain 1 page when there are openai api updates etc.

Transparently more detail was added to give some "meat" to the docs for the Microsoft folks. Realistically the only thing we really need is a single tab in the original OpenAI docs to toggle between "OpenAI" client vs. "AzureOpenAI". Outside the comment posted is there anything else that is considered too much?

@ngrayluna
Copy link
Contributor

E100 [vocab] Runtime error

'config/vocabularies/Docs' directory does not exist

Not sure what this is/where this error comes from

Ignore this. Our doc linter temporarily broke. But it's fixed now :)

@ash0ts ash0ts dismissed morganmcg1’s stale review January 15, 2024 19:44

Addressed the changes mentioned!

@ash0ts ash0ts merged commit 014d312 into main Jan 15, 2024
5 of 6 checks passed
@johndmulhausen johndmulhausen deleted the add-azure-openai branch September 5, 2024 18:00
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