Skip to content

Adds a quick start guide with practical, runnable examples to help new users get started with JSONformer. - #70

Open
AswinKumar1 wants to merge 1 commit into
1rgs:mainfrom
AswinKumar1:docs/add-comprehensive-examples
Open

Adds a quick start guide with practical, runnable examples to help new users get started with JSONformer.#70
AswinKumar1 wants to merge 1 commit into
1rgs:mainfrom
AswinKumar1:docs/add-comprehensive-examples

Conversation

@AswinKumar1

Copy link
Copy Markdown

Motivation

New users need simple, working examples to understand how to use JSONformer. This guide provides:

  • Minimal setup required
  • Real-world use cases (user profiles, product info)
  • Clear success indicators
  • Fast testing with a small model

Changes

  • Created examples/quick_start_guide.py with 2 practical examples
  • Uses DialoGPT-small for fast downloads and testing
  • Examples demonstrate common schema patterns

Testing

poetry run python examples/quick_start_guide.py

Output shows successful JSON generation for both examples.

Checklist

  • Code runs successfully
  • Examples are practical and educational
  • Uses small model for accessibility
  • Clear documentation in comments

- Add runnable examples for user profiles and products
- Use small model for fast testing and onboarding
- Help new users get started quickly with JSONformer
- Include clear output indicators for success
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.

1 participant