Skip to content

docs: Add Getting Started Jupyter Notebook for new users#1279

Open
yuchengpersonal wants to merge 1 commit intollmware-ai:mainfrom
yuchengpersonal:docs/add-getting-started-notebook
Open

docs: Add Getting Started Jupyter Notebook for new users#1279
yuchengpersonal wants to merge 1 commit intollmware-ai:mainfrom
yuchengpersonal:docs/add-getting-started-notebook

Conversation

@yuchengpersonal
Copy link
Copy Markdown

Summary

This PR adds a comprehensive Jupyter Notebook to help new users get started with LLMWare, addressing the request in #508 for improved Jupyter notebook support and examples.

What's Included

The notebook covers:

  1. Installation and Configuration

    • How to install llmware
    • Importing necessary modules
    • Configuration overview
  2. Model Catalog Exploration

    • Listing available models
    • Understanding model families (BLING, SLIM)
  3. Basic Inference Examples

    • Using "bling-phi-3-gguf" for text generation
    • Step-by-step walkthrough
  4. Function Call Examples

    • Sentiment analysis with "slim-sentiment-tool"
    • Named Entity Recognition with "slim-ner-tool"
    • Multiple test cases for each
  5. Troubleshooting Section

    • Common issues and solutions
    • Platform requirements
    • Model cache directory check
  6. Next Steps

    • Recommended learning path
    • Links to other examples

Testing

  • Notebook structure validated
  • All code cells are executable
  • Markdown formatting checked

Related Issue

Fixes #508


Note: This is my first contribution to llmware. I'm excited to help improve the onboarding experience for new users! 🚀

Add a comprehensive Jupyter Notebook to help new users get started with LLMWare.

Features:
- Installation and configuration guide
- Model catalog exploration
- Basic inference examples with bling-phi-3-gguf
- Sentiment analysis using slim-sentiment-tool
- Named Entity Recognition (NER) using slim-ner-tool
- Troubleshooting section with common issues
- Next steps and learning path recommendations

This notebook addresses the request in llmware-ai#508 for improved Jupyter notebook
support and examples.

Fixes llmware-ai#508
@yuchengpersonal
Copy link
Copy Markdown
Author

Hi @doberst, this PR adds a comprehensive Getting Started Jupyter Notebook addressing #508. Please review when convenient. Happy to make any adjustments! Thanks! 🚀

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.

jupyter notebook - more examples and better support

1 participant