Skip to content

adalib.keywords

The Keywords sub-package exposes the core integrations of the keywords in the AdaLab Gallery.

Functions

create_keywords 

create_keywords(new_keywords)

Add a new keyword to the Gallery.

Use the example Jupyter Notebook to test this function or build upon it.

Parameters:

Name Type Description Default
new_keyword str | list

name (or names) of the keywords to be added

 required

Returns:

Type Description
list

a list of dictionaries with the new keyword ids
Source code in adalib/keywords/keywords.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
def create_keywords(
    new_keywords: str | list[str],
) -> list[dict[str, str | int]]:
    """
    Add a new keyword to the Gallery.

    Use the [example Jupyter Notebook](https://github.com/adamatics/adalib_example_notebooks/blob/main/admin/keywords/create_keywords.ipynb) to test this function or build upon it.

    :param new_keyword: name (or names) of the keywords to be added
    :type new_keyword: str or list
    :return: a list of dictionaries with the new keyword ids
    :rtype: list
    """

    if not isinstance(new_keywords, list):
        new_keywords = [new_keywords]

    new_keyword_ids = []
    for new_keyword in new_keywords:
        payload = {"keyword": new_keyword}
        response = adaboard.request_adaboard(
            path="keywords",
            method=requests.post,
            json=payload,
        ).json()

        new_keyword_ids.append(
            {"keyword": new_keyword, "keyword_id": response["id"]}
        )
    return new_keyword_ids

delete_keywords 

delete_keywords(keywords)

Delete keywords from the Gallery.

Use the example Jupyter Notebook to test this function or build upon it.

Parameters:

Name Type Description Default
keywords str | list[str]

keywords to be deleted (tip: all names must be valid, otherwise the process fails)

 required

Returns:

Type Description
None

Nothing
Source code in adalib/keywords/keywords.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
def delete_keywords(keywords: str | list[str]) -> None:
    """
    Delete keywords from the Gallery.

    Use the [example Jupyter Notebook](https://github.com/adamatics/adalib_example_notebooks/blob/main/admin/keywords/delete_keywords.ipynb) to test this function or build upon it.

    :param keywords: keywords to be deleted (tip: all names must be valid, otherwise the process fails)
    :type keywords: str or list
    :return: Nothing
    :rtype: None
    """

    if not isinstance(keywords, list):
        keywords = [keywords]

    keyword_ids = []
    for keyword in keywords:
        kw_id = get_keyword_id(keyword=keyword)
        keyword_ids.append(str(kw_id))
    delete_keywords_by_id(keyword_ids=keyword_ids)

    return None

delete_keywords_by_id 

delete_keywords_by_id(keyword_ids)

Delete keywords from the Gallery based on their ids.

Use the example Jupyter Notebook to test this function or build upon it.

Parameters:

Name Type Description Default
keyword_ids str | list[str]

ids of the keywords to be deleted (tip: all ids must be valid, otherwise the process fails)

 required

Returns:

Type Description
None

Nothing
Source code in adalib/keywords/keywords.py 
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
def delete_keywords_by_id(keyword_ids: str | list[str]) -> None:
    """
    Delete keywords from the Gallery based on their ids.

    Use the [example Jupyter Notebook](https://github.com/adamatics/adalib_example_notebooks/blob/main/admin/keywords/delete_keywords_by_id.ipynb) to test this function or build upon it.

    :param keyword_ids: ids of the keywords to be deleted (tip: all ids must be valid, otherwise the process fails)
    :type keyword_ids: str or list
    :return: Nothing
    :rtype: None
    """

    if not isinstance(keyword_ids, list):
        keyword_ids = [keyword_ids]

    payload = {"keyword_ids": keyword_ids}
    adaboard.request_adaboard(
        path="keywords",
        method=requests.delete,
        json=payload,
    )

    return None

get_keyword_id 

get_keyword_id(keyword)

Find the ID for a specific keyword.

Use the example Jupyter Notebook to test this function or build upon it.

Parameters:

Name Type Description Default
keyword str

name of the keyword

 required

Returns:

Type Description
int | None

id of the keyword, or None if keyword not found
Source code in adalib/keywords/keywords.py 
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
def get_keyword_id(keyword: str) -> int | None:
    """
    Find the ID for a specific keyword.

    Use the [example Jupyter Notebook](https://github.com/adamatics/adalib_example_notebooks/blob/main/user/keywords/get_keyword_id.ipynb) to test this function or build upon it.

    :param keyword: name of the keyword
    :type keyword: str
    :return: id of the keyword, or None if keyword not found
    :rtype: int or None
    """

    kws = get_keywords()
    for kw in kws:
        if keyword == kw["keyword"]:
            return kw["keyword_id"]
    return None

get_keywords 

get_keywords()

Get information about all keywords in the Gallery.

Use the example Jupyter Notebook to test this function or build upon it.

Returns:

Type Description
list

list of dictionaries with keywords data
Source code in adalib/keywords/keywords.py 
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
def get_keywords() -> list[dict[str, str | int]]:
    """
    Get information about all keywords in the Gallery.

    Use the [example Jupyter Notebook](https://github.com/adamatics/adalib_example_notebooks/blob/main/user/keywords/get_keywords.ipynb) to test this function or build upon it.

    :return: list of dictionaries with keywords data
    :rtype: list
    """

    response = adaboard.request_adaboard(
        path="keywords",
        method=requests.get,
    ).json()

    return response

get_keywords_stats 

get_keywords_stats()

Get utilization statistics for the keywords in the Gallery.

Use the example Jupyter Notebook to test this function or build upon it.

Returns:

Type Description
list

list of dictionaries with keywords stats
Source code in adalib/keywords/keywords.py 
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
def get_keywords_stats() -> list[dict[str, str | int]]:
    """
    Get utilization statistics for the keywords in the Gallery.

    Use the [example Jupyter Notebook](https://github.com/adamatics/adalib_example_notebooks/blob/main/user/keywords/get_keywords_stats.ipynb) to test this function or build upon it.

    :return: list of dictionaries with keywords stats
    :rtype: list
    """

    response = adaboard.request_adaboard(
        path="keywords/statistics",
        method=requests.get,
    ).json()

    return response

merge_keywords 

merge_keywords(keywords, new_keyword)

Merge several keywords into a single one.

Use the example Jupyter Notebook to test this function or build upon it.

Parameters:

Name Type Description Default
keywords list[str]

keywords to be merged

 required
new_keyword str

name of the new keyword (note: it can be one of the keywords to be merged)

 required

Returns:

Type Description
int

the new keyword's ID
Source code in adalib/keywords/keywords.py 
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
def merge_keywords(keywords: list[str], new_keyword: str) -> int:
    """
    Merge several keywords into a single one.

    Use the [example Jupyter Notebook](https://github.com/adamatics/adalib_example_notebooks/blob/main/admin/keywords/merge_keywords.ipynb) to test this function or build upon it.

    :param keywords: keywords to be merged
    :type keywords: list
    :param new_keyword: name of the new keyword (note: it can be one of the keywords to be merged)
    :type new_keyword: str
    :return: the new keyword's ID
    :rtype: int
    """

    keyword_ids = []
    for keyword in keywords:
        kw_id = get_keyword_id(keyword=keyword)
        keyword_ids.append(kw_id)

    payload = {"keyword_ids": keyword_ids, "new_keyword": new_keyword}
    response = adaboard.request_adaboard(
        path="keywords/merge",
        method=requests.put,
        json=payload,
    ).json()

    return response["id"]

rename_keyword 

rename_keyword(keyword, new_keyword)

Rename a keyword.

Use the example Jupyter Notebook to test this function or build upon it.

Parameters:

Name Type Description Default
keyword str

the keyword to be renamed

 required
new_keyword str

name of the new keyword

 required

Returns:

Type Description
int

new keyword's id
Source code in adalib/keywords/keywords.py 
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
def rename_keyword(keyword: str, new_keyword: str) -> int | str:
    """
    Rename a keyword.

    Use the [example Jupyter Notebook](https://github.com/adamatics/adalib_example_notebooks/blob/main/admin/keywords/rename_keyword.ipynb) to test this function or build upon it.

    :param keyword: the keyword to be renamed
    :type keyword: str
    :param new_keyword: name of the new keyword
    :type new_keyword: str
    :return: new keyword's id
    :rtype: int
    """

    keyword_id = get_keyword_id(keyword=keyword)
    payload = {"keyword_ids": [keyword_id], "new_keyword": new_keyword}
    response = adaboard.request_adaboard(
        path="keywords/merge",
        method=requests.put,
        json=payload,
    ).json()

    return response["id"]