-
Notifications
You must be signed in to change notification settings - Fork 1
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
7 blueprint guidance docs #30
Conversation
* Add devcontainer and requirements * Add pyproject.toml * Add data_loaders and tests * Add data_cleaners and tests * Update demo * Add `LOADERS` and `CLEANERS` * Add markdown and docx * Add API Reference * Update tests * Update install * Add initial scripts * More tests * fix merge * Add podcast writing to demo/app * Add missing deps * Add text_to_podcast module * Expose model options and prompt tuning in the app * pre-commit * Strip system_prompt * Rename to inference module. Add docstrings * pre-commit * Add CURATED_REPOS * JSON prompt * Update API docs * Fix format * Make text cutoff based on `model.n_ctx()`. Consider ~4 characters per token as a resonable default. * Add inference tests * Drop __init__ imports * Fix outdated arg * Drop redundant JSON output in prompt * Update default stop
…a-ai/OpenNotebookLLM into 7-blueprint-guidance-docs
* Add new `tests` workflow * Use pip cache * Unify env setup. Drop UV in favor of setup-python * Update tests
* Add devcontainer and requirements * Add pyproject.toml * Add data_loaders and tests * Add data_cleaners and tests * Update demo * Add `LOADERS` and `CLEANERS` * Add markdown and docx * Add API Reference * Update tests * Update install * Add initial scripts * More tests * fix merge * Add podcast writing to demo/app * Add missing deps * Add text_to_podcast module * Expose model options and prompt tuning in the app * pre-commit * Strip system_prompt * Rename to inference module. Add docstrings * pre-commit * Add CURATED_REPOS * JSON prompt * Update API docs * Fix format * Make text cutoff based on `model.n_ctx()`. Consider ~4 characters per token as a resonable default. * Add inference tests * Drop __init__ imports * Fix outdated arg * Drop redundant JSON output in prompt * Update default stop
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great start 🚀
I like the content and structure.
I feel like the structure is general enough to be sent upstream to https://github.com/mozilla-ai/Blueprint-template somehow as guidance for future blueprints
Some minor 💅 comments. We can prioritize getting this merged and then update it once we settle on #19
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great stuff @stefanfrench ! Very detailed but without making it feel overwhelming!
Just need to do git pull origin main
before merging to bring the latest from main
so we dont have these extra files showing like changes (.github/workflows/docs.yaml
, etc).
I have done the update via GitHub UI |
Maybe we could add a little troubleshooting section somewhere? Two issues that I encountered where the following:
To solve this I run |
Let's merge this, to have something published on main README and the website, and make the updates like the troubleshooting and updates based on #19 on top |
What's changing
Updated:
added:
How to test it
mkdocs serve
and check the docs, highlighting any critical changes that needs to be madeAdditional notes for reviewers