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

Create JSON_mode_example.ipynb #2554

Merged
merged 13 commits into from May 24, 2024
Merged

Create JSON_mode_example.ipynb #2554

merged 13 commits into from May 24, 2024

Conversation

Aretai-Leah
Copy link
Collaborator

Why are these changes needed?

An example of JSON mode usage in notebook format.

Related issue number

Closes #2224

Checks

@Aretai-Leah
Copy link
Collaborator Author

@microsoft-github-policy-service agree

Copy link
Collaborator

@Josephrp Josephrp left a comment

Choose a reason for hiding this comment

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

let's try to expand , and refocus the theme to something that will resonate or be familiar to the audience, for example the easiest would be to reframe the agents for "business" , like they could be a group of lawyers , or a group of board room advisors (with different roles) , something like that. i also like the negotiation part a lot, but you can bring it home with a more applied business theme , and nested decisions for tool use i think it's one of the good things abotu JSON mode. something else : json mode as input to datasets processing. so it's a good start, but some work ahead to make it perfect for the audience, perhaps 🚀

@Aretai-Leah
Copy link
Collaborator Author

ok I've updated the notebook to be clearer about the role of Description, including adding an image.

I've also reframed the example to cover prompt hack mitigation and included a basic hack as the example. hopefully infosec /cogsec resonates?

Copy link
Collaborator Author

@Aretai-Leah Aretai-Leah left a comment

Choose a reason for hiding this comment

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

ah thanks, I used another AG notebook as an example, and it was present. Didn't think to remove it.

@Aretai-Leah
Copy link
Collaborator Author

ok, so I've made the suggested changes, but I can see there are some failing checks. Apologies, but its not clear to me what those errors mean or how I would resolve them. The notebook executes fine and I removed the cell with the code lab link.

@ekzhu
Copy link
Collaborator

ekzhu commented May 21, 2024

Re pre-commit failure: https://microsoft.github.io/autogen/docs/contributor-guide/pre-commit

Re dock check failure: follow this to set up local website: https://microsoft.github.io/autogen/docs/contributor-guide/documentation. And try to debug the .mdx file generated from the notebook (should be in /website/docs/notebooks after running process_notebooks.py)

Copy link
Collaborator Author

@Aretai-Leah Aretai-Leah left a comment

Choose a reason for hiding this comment

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

fixed formatting errors

@Aretai-Leah
Copy link
Collaborator Author

ok, should be all ready and fixed up.

@Aretai-Leah Aretai-Leah marked this pull request as ready for review May 23, 2024 00:57
@ekzhu ekzhu added this pull request to the merge queue May 24, 2024
Merged via the queue into microsoft:main with commit e87a6a4 May 24, 2024
18 checks passed
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.

Prominent example on using JSON mode
4 participants