hegelai / prompttools

Open-source tools for prompt testing and experimentation, with support for both LLMs (e.g. OpenAI, LLaMA) and vector databases (e.g. Chroma, Weaviate, LanceDB).
http://prompttools.readthedocs.io
Apache License 2.0
2.55k stars 216 forks source link

Examples are mixed/stacking up #81

Closed HashemAlsaket closed 9 months ago

HashemAlsaket commented 10 months ago

📚 The doc issue

Under examples/notebooks there are many example notebooks varying from LLMs, text, images, DBs. Should we store them in separate directories?

Suggest a potential fix

├── examples
├── ├── notebooks
├── ├── ├── benchmark
├── ├── ├── image_experiments
├── ├── ├── ├── StableDiffusionExperiment.ipynb
├── ├── ├── llm_experiments
├── ├── ├── ├── LlamaCppExperiment.ipynb
├── ├── ├── db_experiments
├── ├── ├── ├── LanceDBExperiment.ipynb
├── ├── ├── audio_experiments
├── ├── ├── ├── MusicGenExperiment.ipynb
├── ├── ├── video_experiments
NivekT commented 10 months ago

This is definitely better in the long term. The downside of updating the path is that previous posts (on social media, etc) will have broken links if we directly link to a notebook from those posts.

We will also have to make sure all links within the repo (e.g. doc, README) have the updated links.

NivekT commented 10 months ago

One idea: we can move the notebooks and use symlinks to keep the previous links working.

NivekT commented 9 months ago

I have moved the non-LLM examples to subfolders. Let's close this for now. Feel free to re-open if anyone has concerns about this.