Update readme, setup hooks

.flake8

@@ -0,0 +1,4 @@
+[flake8]
+ignore = E226,E302,E41,C901
+max-line-length = 89
+max-complexity = 10

.isort.cfg

@@ -13,3 +13,4 @@ default_section=THIRDPARTY
 
 known_localfolder=
     ciare_world_creator,
+known_third_party = aiohttp,chromadb,click,langchain,lxml,openai,pandas,pytest,questionary,requests,tabulate,tinydb,tqdm

.pre-commit-config.yaml

@@ -0,0 +1,19 @@
+repos:
+-   repo: https://github.com/asottile/seed-isort-config
+    rev: v2.2.0
+    hooks:
+    - id: seed-isort-config
+-   repo: https://github.com/pre-commit/mirrors-isort
+    rev: v5.10.1
+    hooks:
+    - id: isort
+-   repo: https://github.com/ambv/black
+    rev: 23.3.0
+    hooks:
+    - id: black
+      args: [--line-length, "88", "."]
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    - id: flake8
+      args: [--config, ".flake8"]

README.md

@@ -15,6 +15,10 @@ Imagine a scenario where you want to test the navigation capabilities of a robot
 
 # Features
 
+## Models
+
+Currently it uses gpt-3.5-16k by default, but if you have access to gpt-4, you will be prompted with a selection. Note that gpt-4 performs much better, but not everyone has the invitation from OpenAI to use it.
+
 ## Current limitations
 
 Currently it's Proof Of Concept solution. There will be a lot of future development. Right now it really does often hallucinate and it's spatial notion is not that great, but sometimes it generates something cool.
@@ -44,7 +48,7 @@ Currently, we use https://app.gazebosim.org/dashboard as database of the models.
 | Pile of fruits and other food in empty world | ![alt text](./docs/examples/pile.png)  |
 | Surgical room | ![alt text](./docs/examples/surgical_room.png) |
 | Warehouse shelves | ![alt text](./docs/examples/warehouse_shelves.png) |
-
+| Usual persons living room| ![alt text](./docs/examples/living_room.png) |
 
 
 # Getting Started

ciare_world_creator/commands/create.py

@@ -66,7 +66,10 @@ def cli(ctx):
 
     if len(allowed_models) > 1:
         chosen_model = questionary.select(
-            message="Choose model to generate with. GPT-4 is much better, but also little-bit more expensive",
+            message=(
+                "Choose model to generate with. GPT-4 is much better,"
+                " but also little-bit more expensive"
+            ),
             choices=allowed_models,
             style=STYLE,
         ).ask()
@@ -89,7 +92,9 @@ def cli(ctx):
         )
     except openai.error.AuthenticationError:
         questionary.print(
-            f"OpenAI api key at {cache.cache_path}/openai_api_key incorrect. Regenerate it at https://platform.openai.com/account/api-keys at copy to {cache.cache_path}/openai_api_key",
+            f"OpenAI api key at {cache.cache_path}/openai_api_key incorrect. "
+            "Regenerate it at https://platform.openai.com/account/api-keys at copy "
+            f"to {cache.cache_path}/openai_api_key",
             style="bold italic fg:red",
         )
         sys.exit(os.EX_DATAERR)
@@ -103,7 +108,7 @@ def cli(ctx):
 
     generate_world = questionary.confirm(
         "Do you want to spawn model in an empty world?"
-        "Saying no will download world from database, but it's very unstable. Y/n",
+        " Saying no will download world from database, but it's very unstable. Y/n",
         style=STYLE,
     ).ask()
 
@@ -154,7 +159,8 @@ def cli(ctx):
         if not find_model(model["Model"], full_models):
             models = prompt_model(
                 content,
-                f"{model} was not found in context list. Generate only the one that are in the context",
+                f"{model} was not found in context list. "
+                "Generate only the one that are in the context",
                 chosen_model,
             )
 
@@ -170,7 +176,6 @@ def cli(ctx):
     cleaned_query = re.sub(r'[<>:;.,"/\\|?*]', "", query).strip()
     world_name = f'world_{cleaned_query.replace(" ", "_")}'
 
-    x, y = 0, 0
     include_elements = []
     i = 0
 
@@ -182,7 +187,8 @@ def cli(ctx):
         m = find_model(model["Model"], full_models)
         if not m:
             questionary.print(
-                f"Model {model} was not found in database. LLM hallucinated and made that up, skipping this model...",
+                f"Model {model} was not found in database. "
+                "LLM hallucinated and made that up, skipping this model...",
                 style="bold italic fg:red",
             )
             non_existent_models.append(model)
@@ -197,7 +203,8 @@ def cli(ctx):
             0,
             0,
             0,
-            f"https://fuel.gazebosim.org/1.0/{m['owner']}/models/{m['name'].replace(' ', '%20')}",
+            "https://fuel.gazebosim.org/1.0/"
+            f"{m['owner']}/models/{m['name'].replace(' ', '%20')}",
         )
         include_elements.append(include)
         i = i + 1

pyproject.toml

@@ -21,6 +21,7 @@ asyncio = "^3.4.3"
 aiohttp = "^3.8.4"
 tabulate = "^0.9.0"
 lark = "^1.1.5"
+pre-commit = "^3.3.3"
 
 [tool.poetry.dev-dependencies]
 black = "*"