momegas commited on
Commit
dcb903e
Β·
1 Parent(s): 0cdb9af

πŸ˜… Add come minor docs

Browse files
Files changed (1) hide show
  1. megabots/__init__.py +4 -1
megabots/__init__.py CHANGED
@@ -131,9 +131,9 @@ SUPPORTED_MODELS = {}
131
  def bot(
132
  task: str | None = None,
133
  model: str | None = None,
 
134
  prompt_template: str | None = None,
135
  prompt_variables: list[str] | None = None,
136
- index: str | None = None,
137
  verbose: bool = False,
138
  temperature: int = 0,
139
  **kwargs,
@@ -146,7 +146,10 @@ def bot(
146
  index (str | None, optional): Data that the model will load and store index info.
147
  Can be either a local file path, a pickle file, or a url of a vector database.
148
  By default it will look for a local directory called "files" in the current working directory.
 
 
149
  verbose (bool, optional): Verbocity. Defaults to False.
 
150
 
151
  Raises:
152
  RuntimeError: _description_
 
131
  def bot(
132
  task: str | None = None,
133
  model: str | None = None,
134
+ index: str | None = None,
135
  prompt_template: str | None = None,
136
  prompt_variables: list[str] | None = None,
 
137
  verbose: bool = False,
138
  temperature: int = 0,
139
  **kwargs,
 
146
  index (str | None, optional): Data that the model will load and store index info.
147
  Can be either a local file path, a pickle file, or a url of a vector database.
148
  By default it will look for a local directory called "files" in the current working directory.
149
+ prompt_template (str | None, optional): Prompt template to be used. Specify variables with {var_name}.
150
+ prompt_variables (list[str] | None, optional): Prompt variables to be used in the prompt template.
151
  verbose (bool, optional): Verbocity. Defaults to False.
152
+ temperature (int, optional): Temperature. Defaults to 0.
153
 
154
  Raises:
155
  RuntimeError: _description_