mirror of https://github.com/meta-llama/llama-stack.git synced 2025-06-27 18:50:41 +00:00

Ashwin Bharambe 2a31163178

Auto-generate distro yamls + docs (#468 )

# What does this PR do?

Automatically generates
- build.yaml
- run.yaml
- run-with-safety.yaml
- parts of markdown docs

for the distributions.

## Test Plan

At this point, this only updates the YAMLs and the docs. Some testing
(especially with ollama and vllm) has been performed but needs to be
much more tested.

2024-11-18 14:57:06 -08:00

2.5 KiB

Raw Blame History

Contributing to Llama-Stack

We want to make contributing to this project as easy and transparent as possible.

Pull Requests

We actively welcome your pull requests.

Fork the repo and create your branch from main.
If you've added code that should be tested, add tests.
If you've changed APIs, update the documentation.
Ensure the test suite passes.
Make sure your code lints.
If you haven't already, complete the Contributor License Agreement ("CLA").

Updating Provider Configurations

If you have made changes to a provider's configuration in any form (introducing a new config key, or changing models, etc.), you should run python llama_stack/scripts/distro_codegen.py to re-generate various YAML files as well as the documentation. You should not change docs/source/.../distributions/ files manually as they are auto-generated.

Building the Documentation

If you are making changes to the documentation at https://llama-stack.readthedocs.io/en/latest/, you can use the following command to build the documentation and preview your changes. You will need Sphinx and the readthedocs theme.

cd llama-stack/docs
pip install -r requirements.txt
pip install sphinx-autobuild

# This will start a local server (usually at http://127.0.0.1:8000) that automatically rebuilds and refreshes when you make changes to the documentation.
make html
sphinx-autobuild source build/html

Contributor License Agreement ("CLA")

In order to accept your pull request, we need you to submit a CLA. You only need to do this once to work on any of Meta's open source projects.

Complete your CLA here: https://code.facebook.com/cla

Issues

We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.

Meta has a bounty program for the safe disclosure of security bugs. In those cases, please go through the process outlined on that page and do not file a public issue.

Coding Style

2 spaces for indentation rather than tabs
80 character line length
...

Tips

If you are developing with a llama-stack repository checked out and need your distribution to reflect changes from there, set LLAMA_STACK_DIR to that dir when running any of the llama CLI commands.

License

By contributing to Llama, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.

2.5 KiB Raw Blame History