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.

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

Restructuring Proposal #89

Closed
MichaelClifford opened this issue Mar 21, 2024 · 5 comments
Closed

Restructuring Proposal #89

MichaelClifford opened this issue Mar 21, 2024 · 5 comments

Comments

@MichaelClifford
Copy link
Collaborator

I would like to change the structure of this repo a bit to make it more intuitive and easier to maintain as it continues to grow. Below please find a sketch of the proposed structure.

The main changes would be:

  • playground/ would be moved into model_servers/ and renamed llamacpp_python/
  • A new directory called recipes/ with N subdirectories for each recipe category. Right now that is natural_language_processing/, computer_vision/, audio/ and multimodal/.
  • All existing recipes will be moved to the correct subdirectory.
  • A new directory called VectorDBs/. With the intent to add any new component types that may arise in the future in the same way to the root directory.
  • Move chromadb/ into VectorDBs/

Please let me know what you all think of the proposed changes and how they might affect any dependencies on this repo.

locallm:
|-- assets
    |-- image.1.png
    |-- image2.png
    |-- ...
|-- data
    |-- file.txt
    |-- ...
|-- models
    |-- Model1Folder
    |-- Model2Folder
    |-- Convert_Models
    |-- ...
|-- model_servers
    |-- llamacpp_python
        |-- base
        |-- cuda
        |-- vulkan
        |-- ....
    |-- ollama
        |-- base
        |-- ....
    |-- caikit
        |-- base
        |-- ....
    |-- WhisperCPP
        |-- base
        |-- ....
    |-- ...
|-- recipes
    |-- Natural Language
        |-- Chat
        |-- Summary
        |-- RAG
        |-- Fine Tune
        |-- ...
    |-- Computer Vision
        |-- Object Detection
        |-- ...
    |-- Audio
        |-- Transcription
        |-- ...
    |-- Multimodal
        |-- Image Description
        |-- ...
|-- VectorDBs
    |-- ChromaDB
    |-- ...
@sallyom
Copy link
Collaborator

sallyom commented Mar 21, 2024

I love this plan, I'm ok with it as soon as AI lab can sign off

@jeffmaury
Copy link
Collaborator

What is the schedule ?

@MichaelClifford
Copy link
Collaborator Author

@jeffmaury The sooner that better. When will it have the least impact on AI Studio? After 0.3.0?

@jeffmaury
Copy link
Collaborator

This could be independant as the catalog is using commit SHAs

@MichaelClifford
Copy link
Collaborator Author

@jeffmaury so we can start to make these changes today? Happy to wait until 0.3.0 to make things simple.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

No branches or pull requests

3 participants