[docs] update documentations (#356)

* move docs -> source * Add files via upload * mv image * Add files via upload * colocate iOS setup doc * delete image * Add files via upload * fix * delete image * Add files via upload * Update developer_cookbook.md * toctree * wip subfolder * docs update * subfolder * updates * name * updates * index * updates * refactor structure * depth * docs * content * docs * getting started * distributions * fireworks * fireworks * update * theme * theme * theme * pdj theme * pytorch theme * css * theme * agents example * format * index * headers * copy button * test tabs * test tabs * fix * tabs * tab * tabs * sphinx_design * quick start commands * size * width * css * css * download models * asthetic fix * tab format * update * css * width * css * docs * tab based * tab * tabs * docs * style * image * css * color * typo * update docs * missing links * list templates * links * links update * troubleshooting * fix * distributions * docs * fix table * kill llamastack-local-gpu/cpu * Update index.md * Update index.md * mv ios_setup.md * Update ios_setup.md * Add remote_or_local.gif * Update ios_setup.md * release notes * typos * Add ios_setup to index * nav bar * hide torctree * ios image * links update * rename * rename * docs * rename * links * distributions * distributions * distributions * distributions * remove release * remote --------- Co-authored-by: dltn <6599399+dltn@users.noreply.github.com> Co-authored-by: Ashwin Bharambe <ashwin.bharambe@gmail.com>
2025-07-19 03:10:03 +00:00 · 2024-11-04 16:52:38 -08:00 · 2024-11-04 16:52:38 -08:00 · c810a4184d
commit c810a4184d
parent ac93dd89cf
37 changed files with 1777 additions and 2154 deletions
--- a/docs/source/api_providers/index.md
+++ b/docs/source/api_providers/index.md
@ -0,0 +1,14 @@
+# API Providers
+
+A Provider is what makes the API real -- they provide the actual implementation backing the API.
+
+As an example, for Inference, we could have the implementation be backed by open source libraries like `[ torch | vLLM | TensorRT ]` as possible options.
+
+A provider can also be just a pointer to a remote REST service -- for example, cloud providers or dedicated inference providers could serve these APIs.
+
+```{toctree}
+:maxdepth: 1
+
+new_api_provider
+memory_api
+```
--- a/docs/source/api_providers/memory_api.md
+++ b/docs/source/api_providers/memory_api.md
@ -0,0 +1,53 @@
+# Memory API Providers
+
+This guide gives you references to switch between different memory API providers.
+
+##### pgvector
+1. Start running the pgvector server:
+
+```
+$ docker run --network host --name mypostgres -it -p 5432:5432 -e POSTGRES_PASSWORD=mysecretpassword -e POSTGRES_USER=postgres -e POSTGRES_DB=postgres pgvector/pgvector:pg16
+```
+
+2. Edit the `run.yaml` file to point to the pgvector server.
+```
+memory:
+  - provider_id: pgvector
+    provider_type: remote::pgvector
+    config:
+      host: 127.0.0.1
+      port: 5432
+      db: postgres
+      user: postgres
+      password: mysecretpassword
+```
+
+> [!NOTE]
+> If you get a `RuntimeError: Vector extension is not installed.`. You will need to run `CREATE EXTENSION IF NOT EXISTS vector;` to include the vector extension. E.g.
+
+```
+docker exec -it mypostgres ./bin/psql -U postgres
+postgres=# CREATE EXTENSION IF NOT EXISTS vector;
+postgres=# SELECT extname from pg_extension;
+ extname
+```
+
+3. Run `docker compose up` with the updated `run.yaml` file.
+
+##### chromadb
+1. Start running chromadb server
+```
+docker run -it --network host --name chromadb -p 6000:6000 -v ./chroma_vdb:/chroma/chroma -e IS_PERSISTENT=TRUE chromadb/chroma:latest
+```
+
+2. Edit the `run.yaml` file to point to the chromadb server.
+```
+memory:
+  - provider_id: remote::chromadb
+    provider_type: remote::chromadb
+    config:
+      host: localhost
+      port: 6000
+```
+
+3. Run `docker compose up` with the updated `run.yaml` file.
--- a/docs/source/api_providers/new_api_provider.md
+++ b/docs/source/api_providers/new_api_provider.md
@ -0,0 +1,26 @@
+# Developer Guide: Adding a New API Provider
+
+This guide contains references to walk you through adding a new API provider.
+
+### Adding a new API provider
+1. First, decide which API your provider falls into (e.g. Inference, Safety, Agents, Memory).
+2. Decide whether your provider is a remote provider, or inline implmentation. A remote provider is a provider that makes a remote request to an service. An inline provider is a provider where implementation is executed locally. Checkout the examples, and follow the structure to add your own API provider. Please find the following code pointers:
+
+    - [Inference Remote Adapter](https://github.com/meta-llama/llama-stack/tree/docs/llama_stack/providers/adapters/inference)
+    - [Inference Inline Provider](https://github.com/meta-llama/llama-stack/tree/docs/llama_stack/providers/impls/meta_reference/inference)
+
+3. [Build a Llama Stack distribution](https://llama-stack.readthedocs.io/en/latest/distribution_dev/building_distro.html) with your API provider.
+4. Test your code!
+
+### Testing your newly added API providers
+
+1. Start with an _integration test_ for your provider. That means we will instantiate the real provider, pass it real configuration and if it is a remote service, we will actually hit the remote service. We **strongly** discourage mocking for these tests at the provider level. Llama Stack is first and foremost about integration so we need to make sure stuff works end-to-end. See [llama_stack/providers/tests/inference/test_inference.py](../llama_stack/providers/tests/inference/test_inference.py) for an example.
+
+2. In addition, if you want to unit test functionality within your provider, feel free to do so. You can find some tests in `tests/` but they aren't well supported so far.
+
+3. Test with a client-server Llama Stack setup. (a) Start a Llama Stack server with your own distribution which includes the new provider. (b) Send a client request to the server. See `llama_stack/apis/<api>/client.py` for how this is done. These client scripts can serve as lightweight tests.
+
+You can find more complex client scripts [llama-stack-apps](https://github.com/meta-llama/llama-stack-apps/tree/main) repo. Note down which scripts works and do not work with your distribution.
+
+### Submit your PR
+After you have fully tested your newly added API provider, submit a PR with the attached test plan. You must have a Test Plan in the summary section of your PR.