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.

Sign up for GitHub

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

Jump to bottom

7 blueprint guidance docs #30

Merged
merged 20 commits into from
Dec 3, 2024
Merged

7 blueprint guidance docs #30

merged 20 commits into from
Dec 3, 2024

Conversation

stefanfrench
Copy link
Contributor

@stefanfrench stefanfrench commented Dec 2, 2024 •
edited
Loading

What's changing

Updated:

  • read.me
  • index.md
  • mkdocs.yml

added:

  • a number of files under docs/ (including assets, images, and number of .md files):
    • customization.md
    • future-features-contributions.md
    • getting-started.md
    • step-by-step-guide.md
    • custom.css

How to test it

  • Sense check the read.me - highlight any critical changes that should be made
  • run mkdocs serve and check the docs, highlighting any critical changes that needs to be made

Additional notes for reviewers

  • Theres still a lot of room for improvement, but please view this as the MVP for the docs.

stefanfrench and others added 14 commits November 22, 2024 12:05
@stefanfrench
update read.me with guidance docs initial draft
5817ca9
@stefanfrench
minor update to read.me
b5bc53d
@daavoo @stefanfrench
podcast script generation component (#15)
8dd268d 
* 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
@stefanfrench
updates to read.me to simplify down and add diagram
a464976
@stefanfrench
update read.me with guidance docs initial draft
7d3bc1f
@stefanfrench
minor update to read.me
f80072e
@stefanfrench
updates to read.me to simplify down and add diagram
fdf8dc3
@stefanfrench
updated docs and added new pages and assets
ff6a2da
@stefanfrench
Merge branch '7-blueprint-guidance-docs' of https://github.com/mozill…
0ad0f43 
…a-ai/OpenNotebookLLM into 7-blueprint-guidance-docs
@stefanfrench
Changes to the docs files
42a23bf
@stefanfrench
deleting contributing.md from docs
8e86678
@daavoo @stefanfrench
Add tests workflow (#18)
1e2ec2e 
* Add new `tests` workflow

* Use pip cache

* Unify env setup. Drop UV in favor of setup-python

* Update tests
@daavoo @stefanfrench
podcast script generation component (#15)
5821440 
* 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
@stefanfrench
pre commit checks
17de479
@stefanfrench stefanfrench linked an issue Dec 2, 2024 that may be closed by this pull request
Blueprint Guidance Docs #7
Closed
daavoo
daavoo approved these changes Dec 2, 2024
View reviewed changes
Copy link
Contributor

@daavoo daavoo left a 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

mkdocs.yml Show resolved Hide resolved
docs/customization.md Outdated Show resolved Hide resolved
docs/customization.md Outdated Show resolved Hide resolved
docs/customization.md Outdated Show resolved Hide resolved
docs/customization.md Outdated Show resolved Hide resolved
docs/customization.md Outdated Show resolved Hide resolved
docs/step-by-step-guide.md Outdated Show resolved Hide resolved
docs/step-by-step-guide.md Show resolved Hide resolved
docs/getting-started.md Show resolved Hide resolved
docs/step-by-step-guide.md Outdated Show resolved Hide resolved
daavoo
daavoo reviewed Dec 2, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
Kostis-S-Z
Kostis-S-Z approved these changes Dec 3, 2024
View reviewed changes
Copy link
Contributor

@Kostis-S-Z Kostis-S-Z left a 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).

Kostis-S-Z
Kostis-S-Z reviewed Dec 3, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
@daavoo
Copy link
Contributor

daavoo commented Dec 3, 2024

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

@Kostis-S-Z
Copy link
Contributor

Maybe we could add a little troubleshooting section somewhere? Two issues that I encountered where the following:

  1. In Firefox if you have Enhanced Tracking Protection ON you will get Oh on, it looks like you are offline!. You need to turn it OFF.
  2. In a local, "clean" Ubuntu system, installation of our package fails with
  × Building wheel for llama-cpp-python (pyproject.toml) did not run successfully.
  │ exit code: 1
  ╰─> [16 lines of output]
  	*** scikit-build-core 0.10.7 using CMake 3.31.1 (wheel)
  	*** Configuring CMake...
  	loading initial cache file /tmp/tmp889ry2ss/build/CMakeInit.txt
  	CMake Error at /tmp/pip-build-env-0q5z11ag/normal/lib/python3.12/site-packages/cmake/data/share/cmake-3.31/Modules/CMakeDetermineCCompiler.cmake:49 (message):
    	Could not find compiler set in environment variable CC:
 	 
    	x86_64-linux-gnu-gcc.
  	Call Stack (most recent call first):
    	CMakeLists.txt:3 (project)
 	 
 	 
  	CMake Error: CMAKE_C_COMPILER not set, after EnableLanguage
  	CMake Error: CMAKE_CXX_COMPILER not set, after EnableLanguage
  	-- Configuring incomplete, errors occurred!
 	 
  	*** CMake configuration failed
  	[end of output]
 
  note: This error originates from a subprocess, and is likely not a problem with pip.
  ERROR: Failed building wheel for llama-cpp-python

To solve this I run sudo apt install build-essential, but basically, to my understanding, you need to install the GNU compiler collection (GCC) and GNU make.

@stefanfrench stefanfrench mentioned this pull request Dec 3, 2024
Closed
@daavoo
Copy link
Contributor

daavoo commented Dec 3, 2024

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

@daavoo daavoo merged commit ab1c6c8 into main Dec 3, 2024
2 checks passed
@daavoo daavoo deleted the 7-blueprint-guidance-docs branch December 3, 2024 11:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@daavoo daavoo daavoo approved these changes

@Kostis-S-Z Kostis-S-Z Kostis-S-Z approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Blueprint Guidance Docs
3 participants
@stefanfrench @daavoo @Kostis-S-Z