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

Updating Docs #1

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@
branch = main
[submodule "nebullvm"]
path = nebullvm
url = https://github.com/nebuly-ai/nebullvm
url = https://github.com/nebuly-ai/nebuly
branch = main
4 changes: 1 addition & 3 deletions docs/contributions.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,4 @@ We are glad that you decided to contribute to the library and we thank you for y
Did you spot a bug? Did you come up with a cool idea that you think should be implemented in the libraries? Well, GitHub issues are the best way to let us know!
We don't have a strict policy on issue generation: just use a meaningful title and specify the problem or your proposal in the first problem comment. Then, you can use GitHub labels to let us know what kind of proposal you are making, for example bug if you are reporting a new bug or enhancement if you are proposing a library improvement. Please remeber to specifiy the module to which the issue is related (e.g Speedster, Promptify, etc). If it's one of your first contributions, check the tag `good first issue` 🏁 and start coding.



Happy coding 💫
Happy coding 💫
15 changes: 7 additions & 8 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# Quickstart


`Nebullvm` is an ecosystem of plug and play modules to boost the performances of your AI systems. The optimization modules are stack-agnostic and work with any library. They are designed to be easily integrated into your system, providing a quick and seamless boost to its performance. Simply plug and play to start realizing the benefits of optimized performance right away.

If you like the idea, give us a star to show your support for the project ⭐
Expand All @@ -9,26 +8,26 @@ If you like the idea, give us a star to show your support for the project ⭐

There are multiple modules we actually provide to boost the performances of your AI systems:

- [x] [Speedster](https://github.com/nebuly-ai/nebullvm/blob/main/apps/accelerate/speedster): Automatically apply the best set of SOTA optimization techniques to achieve the maximum inference speed-up on your hardware.
- [x] [Speedster](https://github.com/nebuly-ai/nebuly/tree/main/optimization/speedster): Automatically apply the best set of SOTA optimization techniques to achieve the maximum inference speed-up on your hardware.

- [x] [Nos](https://github.com/nebuly-ai/nos): Automatically maximize the utilization of GPU resources in a Kubernetes cluster through real-time dynamic partitioning and elastic quotas - Effortless optimization at its finest!

- [x] [ChatLLaMA](https://github.com/nebuly-ai/nebullvm/tree/main/apps/accelerate/chatllama): Build faster and cheaper ChatGPT-like training process based on LLaMA architectures.
- [x] [ChatLLaMA](https://github.com/nebuly-ai/nebuly/tree/main/optimization/chatllama): Build faster and cheaper ChatGPT-like training process based on LLaMA architectures.

- [x] [OpenAlphaTensor](https://github.com/nebuly-ai/nebullvm/tree/main/apps/accelerate/open_alpha_tensor): Increase the computational performances of an AI model with custom-generated matrix multiplication algorithm fine-tuned for your specific hardware.
- [x] [OpenAlphaTensor](https://github.com/nebuly-ai/nebuly/tree/main/optimization/open_alpha_tensor): Increase the computational performances of an AI model with custom-generated matrix multiplication algorithm fine-tuned for your specific hardware.

- [x] [Forward-Forward](https://github.com/nebuly-ai/nebullvm/tree/main/apps/accelerate/forward_forward): The Forward Forward algorithm is a method for training deep neural networks that replaces the backpropagation forward and backward passes with two forward passes.
- [x] [Forward-Forward](https://github.com/nebuly-ai/nebuly/tree/main/optimization/forward_forward): The Forward Forward algorithm is a method for training deep neural networks that replaces the backpropagation forward and backward passes with two forward passes.

## Next modules and roadmap
We are actively working on incorporating the following modules, as requested by members of our community, in upcoming releases:

- [ ] [Promptify](https://github.com/nebuly-ai/nebullvm/blob/main/apps/extract/promptify): Effortlessly personalize large APIs generative models from OpenAI, Cohere, HF to your specific context and requirements.
- [ ] [CloudSurfer](https://github.com/nebuly-ai/nebullvm/blob/main/apps/accelerate/cloud_surfer): Automatically discover the optimal cloud configuration and hardware on AWS, GCP and Azure to run your AI models.
- [ ] [OptiMate](https://github.com/nebuly-ai/nebullvm/blob/main/apps/accelerate/optimate): Interactive tool guiding savvy users in achieving the best inference performance out of a given model / hardware setup.
- [ ] [CloudSurfer](https://github.com/nebuly-ai/nebuly/tree/main/optimization/cloud_surfer): Automatically discover the optimal cloud configuration and hardware on AWS, GCP and Azure to run your AI models.
- [ ] [OptiMate](https://github.com/nebuly-ai/nebuly/tree/main/optimization/optimate): Interactive tool guiding savvy users in achieving the best inference performance out of a given model / hardware setup.
- [ ] [TrainingSim](https://github.com/nebuly-ai/nebullvm/blob/main/apps/simulate/training_sim): Easily simulate the training of large AI models on a distributed infrastructure to predict training behaviours without actual implementation.

## Contributing
As an open source project in a rapidly evolving field, we welcome contributions of all kinds, including new features, improved infrastructure, and better documentation. If you're interested in contributing, please see the [linked](https://docs.nebuly.com/welcome/questions-and-contributions) page for more information on how to get involved.
As an open source project in a rapidly evolving field, we welcome contributions of all kinds, including new features, improved infrastructure, and better documentation. If you're interested in contributing, please see the [linked](https://docs.nebuly.com/contributions/) page for more information on how to get involved.

---

Expand Down
8 changes: 4 additions & 4 deletions mkdocs.yaml
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
site_name: Documentation
repo_url: https://github.com/nebuly-ai/nebullvm
repo_name: nebuly-ai/nebullvm
repo_url: https://github.com/nebuly-ai/nebuly
repo_name: nebuly-ai/nebuly


nav:
- 👋 Welcome:
- Quickstart: index.md
- Contribution guidelines: contributions.md
- Modules:
- Speedster: '!include nebullvm/apps/accelerate/speedster/docs/en/mkdocs.yaml'
- Nos: '!include ./nos/docs/en/mkdocs.yaml'
- Speedster: '!include nebullvm/optimization/speedster/docs/en/mkdocs.yaml'
- Nos: '!include nos/docs/en/mkdocs.yaml'

plugins:
- monorepo
Expand Down
2 changes: 1 addition & 1 deletion nebullvm
2 changes: 1 addition & 1 deletion nos
Submodule nos updated 3 files
+4 −4 go.mod
+8 −8 go.sum
+5 −2 pkg/gpu/client.go