Merge pull request #6 from Dobiasd/main

Change model_type to base_model in docs
mantasu · Nov 21, 2023 · d47065a · d47065a
2 parents 3ce29d2 + f2ce33b
commit d47065a
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -165,7 +165,7 @@ You can import the package and its models via the python script for more flexibi
 ```python
 from glasses_detector import SunglassesClassifier
 
-classifier = SunglassesClassifier(model_type="small", pretrained=True).eval()
+classifier = SunglassesClassifier(base_model="small", pretrained=True).eval()
 
 classifier.predict(
     input_path="path/to/dir", 
@@ -179,8 +179,8 @@ Using a segmenter is similar, here is an example of using a sunglasses segmentat
 ```python
 from glasses_detector import FullSunglassesSegmenter
 
-# model_type can also be a tuple: (classifier size, base glasses segmenter size)
-segmenter = FullSunglassesSegmenter(model_type="small", pretrained=True).eval()
+# base_model can also be a tuple: (classifier size, base glasses segmenter size)
+segmenter = FullSunglassesSegmenter(base_model="small", pretrained=True).eval()
 
 segmenter.predict(
     input_path="path/to/dir",

diff --git a/docs/content/examples.rst b/docs/content/examples.rst
@@ -35,7 +35,7 @@ You can import the package and its models via the python script for more flexibi
 
     from glasses_detector import SunglassesClassifier
 
-    classifier = SunglassesClassifier(model_type="small", pretrained=True).eval()
+    classifier = SunglassesClassifier(base_model="small", pretrained=True).eval()
 
     classifier.predict(
         input_path="path/to/dir", 
@@ -50,8 +50,8 @@ Using a segmenter is similar, here is an example of using a sunglasses segmentat
 
     from glasses_detector import FullSunglassesSegmenter
 
-    # model_type can also be a tuple: (classifier size, base glasses segmenter size)
-    segmenter = FullSunglassesSegmenter(model_type="small", pretrained=True).eval()
+    # base_model can also be a tuple: (classifier size, base glasses segmenter size)
+    segmenter = FullSunglassesSegmenter(base_model="small", pretrained=True).eval()
 
     segmenter.predict(
         input_path="path/to/dir",

diff --git a/setup.py b/setup.py
@@ -150,7 +150,7 @@
 ```python
 from glasses_detector import SunglassesClassifier
 
-classifier = SunglassesClassifier(model_type="small", pretrained=True).eval()
+classifier = SunglassesClassifier(base_model="small", pretrained=True).eval()
 
 classifier.predict(
     input_path="path/to/dir", 
@@ -164,8 +164,8 @@
 ```python
 from glasses_detector import FullSunglassesSegmenter
 
-# model_type can also be a tuple: (classifier size, base glasses segmenter size)
-segmenter = FullSunglassesSegmenter(model_type="small", pretrained=True).eval()
+# base_model can also be a tuple: (classifier size, base glasses segmenter size)
+segmenter = FullSunglassesSegmenter(base_model="small", pretrained=True).eval()
 
 segmenter.predict(
     input_path="path/to/dir",