Merge pull request #7 from Aisuko/fix/structure

Add new command and re-structure project
SkywardAI · Apr 2, 2024 · 9343f22 · 9343f22
2 parents b99fcad + 33e6a11
commit 9343f22
Show file tree

Hide file tree

Showing 29 changed files with 104 additions and 787 deletions.
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -8,7 +8,7 @@
             "name": "Auto - Debbug kimchima",
             "type": "python",
             "request": "launch",
-            "program": "${workspaceFolder}/kimchima.py",
+            "program": "${workspaceFolder}/src/kimchima/cmds/kimchima_cli.py",
             "console": "integratedTerminal",
             "purpose": [
                 "debug-in-terminal"

diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -2,7 +2,7 @@
     "python.testing.unittestArgs": [
         "-v",
         "-s",
-        ".",
+        "./src",
         "-p",
         "test_*.py"
     ],

diff --git a/MANIFEST.in b/MANIFEST.in
diff --git a/Makefile b/Makefile
@@ -1,3 +1,7 @@
+#################################################################
+TESTDIR:=src/kimchima/tests/
+
+##############################Legacy#############################
 .PHONY: setup
 setup:
 	python setup.py sdist bdist_wheel
@@ -10,6 +14,7 @@ upload:
 ################################Poetry################################
 .PHONY: poetry
 poetry:
+	@poetry config virtualenvs.in-project true
 	@pipx install poetry==1.8.2
 
 
@@ -25,7 +30,7 @@ install:
 
 .PHONY: test
 test:
-	@poetry run python -m unittest discover -v
+	@poetry run python -m unittest discover ${TESTDIR} -v
 
 
 # build and publish

diff --git a/README.md b/README.md
@@ -10,13 +10,6 @@ The collections of tools for ML model development.
 
 You can use it as a command line tool if you like. And you can also use it as a library. Or you can run it in VSCode with [`launch.json`](.vscode/launch.json).
 
-## Command Line Tool
-
-```bash
-$ python -m kimchima auto sentence-transformers/all-MiniLM-L6-v2 Melbourne 
-
-```
-
 
 
 # Acknowledgement

diff --git a/cmds/__init__.py b/cmds/__init__.py
diff --git a/examples/examples.py b/examples/examples.py
@@ -0,0 +1,20 @@
+from kimchima import Auto, get_device, get_capability
+
+model = Auto(model_name_or_path="sentence-transformers/all-MiniLM-L6-v2")
+
+# computing embeddings for single text
+embeddings = model.get_embeddings(text="Melbourne")
+print(embeddings.shape)
+
+# computing embeddings for multiple texts
+embeddings = model.get_embeddings(text=["Melbourne", "Sydney"])
+print(embeddings.shape)
+
+# Checking the device: GPU, mps and CPU
+device = get_device()
+print(device)
+
+
+# get capability of GPU(Nvidia)
+capability = get_capability()
+print(capability)
diff --git a/pkg/__init__.py b/pkg/__init__.py
diff --git a/pkg/auto/__init__.py b/pkg/auto/__init__.py
diff --git a/pkg/devices/__init__.py b/pkg/devices/__init__.py
diff --git a/pkg/dump/__init__.py b/pkg/dump/__init__.py
diff --git a/pkg/dump/dump.py b/pkg/dump/dump.py
diff --git a/pkg/model/__init__.py b/pkg/model/__init__.py
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,7 +2,7 @@ @@
         "python.testing.unittestArgs": [
             "-v",
             "-s",
-            ".",
+            "./src",
             "-p",
             "test_*.py"
         ],
@@ Expand Down @@