From 11f92c0074ab86d910fcde251a7fbe15a27b4b8a Mon Sep 17 00:00:00 2001
From: ishaan-jaff <ishaanjaffer0324@gmail.com>
Date: Tue, 2 Jan 2024 12:14:32 +0530
Subject: [PATCH] (docs) router- init params

---
 docs/my-website/docs/routing.md | 38 +++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)

diff --git a/docs/my-website/docs/routing.md b/docs/my-website/docs/routing.md
index a0e30cf16..ce2f491b2 100644
--- a/docs/my-website/docs/routing.md
+++ b/docs/my-website/docs/routing.md
@@ -571,3 +571,41 @@ print(f"response: {response}")
 ## Deploy Router 
 
 If you want a server to load balance across different LLM APIs, use our [OpenAI Proxy Server](./simple_proxy#load-balancing---multiple-instances-of-1-model)
+
+
+## Init Params for the litellm.Router
+
+```python
+def __init__(
+	model_list: Optional[list] = None,
+	
+	## CACHING ##
+	redis_url: Optional[str] = None,
+	redis_host: Optional[str] = None,
+	redis_port: Optional[int] = None,
+	redis_password: Optional[str] = None,
+	cache_responses: Optional[bool] = False,
+	cache_kwargs: dict = {},  # additional kwargs to pass to RedisCache (see caching.py)
+	caching_groups: Optional[
+		List[tuple]
+	] = None,  # if you want to cache across model groups
+	client_ttl: int = 3600,  # ttl for cached clients - will re-initialize after this time in seconds
+
+	## RELIABILITY ##
+	num_retries: int = 0,
+	timeout: Optional[float] = None,
+	default_litellm_params={},  # default params for Router.chat.completion.create
+	set_verbose: bool = False,
+	fallbacks: List = [],
+	allowed_fails: Optional[int] = None,
+	context_window_fallbacks: List = [],
+	model_group_alias: Optional[dict] = {},
+	retry_after: int = 0,  # min time to wait before retrying a failed request
+	routing_strategy: Literal[
+		"simple-shuffle",
+		"least-busy",
+		"usage-based-routing",
+		"latency-based-routing",
+	] = "simple-shuffle",
+):
+```