added docs

supported_models.py

@@ -1,4 +1,4 @@
-from typing import Generator, Set, Union, List
+from typing import Generator, Set, Union, List, Optional
 
 import requests
 from bs4 import BeautifulSoup, Tag, NavigableString, PageElement
@@ -19,36 +19,41 @@ DEFAULT_MIN_NUMBER_OF_LIKES = 20
 
 
 def get_model_name(model_card: Tag) -> str:
+    """returns the model name from the model card tag"""
     h4_class = "text-md truncate font-mono text-black dark:group-hover:text-yellow-500 group-hover:text-indigo-600"
     h4_tag = model_card.find("h4", class_=h4_class)
     return h4_tag.text
 
 
-def is_a_number(elem: PageElement) -> bool:
-    text = elem.text
+def is_a_number(element: Union[PageElement, Tag]) -> bool:
+    """returns True if the element is a number, False otherwise"""
+    if isinstance(element, Tag):
+        return False
+    text = element.text
     lowered_text = text.strip().lower()
     no_characters_text = lowered_text.replace("k", "").replace("m", "").replace("b", "")
-    elem = no_characters_text.replace(",", "").replace(".", "")
+    element = no_characters_text.replace(",", "").replace(".", "")
     try:
-        float(elem)
+        float(element)
     except ValueError:
         return False
     return True
 
 
 def get_numeric_contents(model_card: Tag) -> List[PageElement]:
+    """returns the number of likes and downloads from the model card tag it they exist in the model card"""
     div: Union[Tag | NavigableString] = model_card.find(
         "div",
         class_="mr-1 flex items-center overflow-hidden whitespace-nowrap text-sm leading-tight text-gray-400",
         recursive=True
     )
     contents: List[PageElement] = div.contents
-    contents_without_tags: List[PageElement] = [content for content in contents if not isinstance(content, Tag)]
-    number_contents: List[PageElement] = [content for content in contents_without_tags if is_a_number(content)]
+    number_contents: List[PageElement] = [content for content in contents if is_a_number(content)]
     return number_contents
 
 
 def convert_to_int(element: PageElement) -> int:
+    """converts the element to an int"""
     element_str = element.text.strip().lower()
     if element_str.endswith("k"):
         return int(float(element_str[:-1]) * 1_000)
@@ -56,11 +61,11 @@ def convert_to_int(element: PageElement) -> int:
         return int(float(element_str[:-1]) * 1_000_000)
     elif element_str.endswith("b"):
         return int(float(element_str[:-1]) * 1_000_000_000)
-    else:
-        return int(element_str)
+    return int(element_str)
 
 
-def get_page(page_index: int):
+def get_page(page_index: int) -> Optional[BeautifulSoup]:
+    """returns the page with the given index if it exists, None otherwise"""
     curr_page_url = f"{SUPPORTED_MODEL_NAME_PAGES_FORMAT}&p={page_index}"
     response = requests.get(curr_page_url)
     if response.status_code == 200:
@@ -75,6 +80,7 @@ def card_filter(
         min_number_of_downloads: int,
         min_number_of_likes: int,
 ) -> bool:
+    """returns True if the model card is valid, False otherwise"""
     if model_name in BLACKLISTED_MODEL_NAMES:
         return False
     numeric_contents = get_numeric_contents(model_card)
@@ -96,6 +102,7 @@ def get_model_names(
         min_number_of_downloads: int,
         min_number_of_likes: int,
 ) -> Generator[str, None, None]:
+    """Scrapes the model names from the given soup"""
     model_cards: List[Tag] = soup.find_all("article", class_="overview-card-wrapper group", recursive=True)
     for model_card in model_cards:
         model_name = get_model_name(model_card)