TestTopicGPT_prompting.py 18.9 KB
1 2 3 4 5 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 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 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 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
"""
This class is used to mainly test the prompting functionality of the TopicGPT package. 
"""

import os 
import sys
import inspect

import openai
import pickle
import unittest

from topicgpt.TopicGPT import TopicGPT
from topicgpt.TopicRepresentation import Topic
from topicgpt.Clustering import Clustering_and_DimRed
from topicgpt.TopwordEnhancement import TopwordEnhancement
from topicgpt.TopicPrompting import TopicPrompting


# TODO: The 'openai.organization' option isn't read in the client API. You will need to pass it when you instantiate the client, e.g. 'OpenAI(organization=os.environ.get('OPENAI_ORG'))'
# openai.organization = os.environ.get('OPENAI_ORG')

class TestTopicGPT_prompting(unittest.TestCase):
    """
    This class is used to mainly test the prompting functionality of the TopicGPT class.
    """

    @classmethod
    def setUp(self):
        """
        load the necessary topic prompting object
        """

        print("Setting up class...")
        try:
            with open("Data/SavedTopicRepresentations/TopicGpt_20ng.pkl", "rb")  as f:
                self.topicgpt = pickle.load(f)
        except FileNotFoundError:
              with open("../../Data/SavedTopicRepresentations/TopicGpt_20ng.pkl", "rb")  as f:
                self.topicgpt = pickle.load(f)

        print(f"The topic list of this object is: \n {self.topicgpt.topic_lis} \n\n")

    def test_visualize_clusters(self):
        """
        test the visualize_clusters function of the TopicGPT class
        """
        print("Testing visualize_clusters...")
        self.topicgpt.visualize_clusters()

    def test_repr_topics(self):
        """
        test the repr_topics function of the TopicGPT class
        """
        print("Testing repr_topics...")
        self.assertTrue(type(self.topicgpt.repr_topics()) == str)

    def test_promt_knn_search(self):
        """
        test the ppromt function that calls knn_search of the TopicPrompting class
        """
        print("Testing ppromt_knn_search...")

        prompt_lis = ["Is topic 0 about Bananas? Use knn Search",
                      "Is topic 0 about Space? Use knn Search",
                      "Is topic 13 about Space exploration? Use knn Search"]

        for prompt in prompt_lis:

            answer, function_result = self.topicgpt.prompt(prompt)

            print(f"Answer to the prompt '{prompt}' \n is \n '{answer}'")

            self.assertTrue(type(answer) == str)
            self.assertTrue(type(function_result[0]) == list)
            self.assertTrue(type(function_result[1]) == list)
            self.assertTrue(type(function_result[0][0]) == str)
            self.assertTrue(type(function_result[1][0]) == int)

    def test_promt_identify_topic_idx(self):
        """
        test the ppromt function that calls identify_topic_idx of the TopicPrompting class
        """

        print("Testing ppromt_identify_topic_idx...")
        prompt_lis = ["What is the index of the topic about Space?",
                      "What is the index of the topic about cars?",
                      "What is the index of the topic about gun control?"]
        correct_indices = [13, 9, 2]

        for prompt, correct_idx in zip(prompt_lis, correct_indices):

            answer, function_result = self.topicgpt.prompt(prompt)

            print(f"Answer to the prompt '{prompt}' \n is \n '{answer}'")
            print("function_result: ", function_result)
            self.assertTrue(type(answer) == str)
            self.assertTrue(type(function_result) == int)
            self.assertTrue(function_result == correct_idx) # topic 14 is about space

    def test_prompt_identify_topc_idx_no_index_prompt(self):
        """
        test the ppromt function that calls identify_topic_idx of the TopicPrompting class
        """

        print("Testing ppromt_identify_topic_idx...")
        no_index_prompt = "What is the index of the topic about bananas?"

        answer, function_result = self.topicgpt.prompt(no_index_prompt)

        print(f"Answer to the prompt '{no_index_prompt}' \n is \n '{answer}'")
        self.assertTrue(type(answer) == str)
        self.assertTrue(function_result == None)

    def test_prompt_split_topic_kmeans(self):
        """
        test the ppromt function that calls split_topic_kmeans of the TopicPrompting class
        """

        print("Testing ppromt_split_topic_kmeans...")

        prompt_lis = ["Split topic 0 into 2 subtopics using kmeans",
                        "Split topic 1 into 3 subtopics using kmeans",
                        "Split topic 2 into 4 subtopics using kmeans"]
        added_topic_lis_len  = [2, 3, 4]

        for prompt, added_topic_len in zip(prompt_lis, added_topic_lis_len):

                answer, function_result = self.topicgpt.prompt(prompt)

                print(f"Answer to the prompt '{prompt}' \n is \n '{answer}'")
                print("function_result: ", function_result)

                self.assertTrue(type(answer) == str)
                self.assertTrue(type(function_result) == list)
                self.assertTrue(type(function_result[0]) == Topic)
                self.assertTrue(len(function_result) == added_topic_len + len(self.topicgpt.topic_lis) -1 )

    def test_prompt_split_topic_kmeans_inplace(self):
        """
        test the ppromt function that calls split_topic_kmeans of the TopicPrompting class
        """

        print("Testing ppromt_split_topic_kmeans...")

        prompt_lis = ["Split topic 0 into 2 subtopics using kmeans. Do this inplace"]
        added_topic_lis_len  = [2]

        old_number_of_topics = len(self.topicgpt.topic_lis)

        for prompt, added_topic_len in zip(prompt_lis, added_topic_lis_len):

                answer, function_result = self.topicgpt.prompt(prompt)

                print(f"Answer to the prompt '{prompt}' \n is \n '{answer}'")
                print("function_result: ", function_result)

                self.assertTrue(type(answer) == str)
                self.assertTrue(type(function_result) == list)
                self.assertTrue(type(function_result[0]) == Topic)

                self.assertTrue(len(self.topicgpt.topic_lis) == old_number_of_topics + added_topic_len -1 )
                self.assertTrue(self.topicgpt.topic_lis == function_result)

    def test_prompt_split_topic_hdbscan(self):
        """
        test the ppromt function that calls split_topic_hdbscan of the TopicPrompting class
        """

        print("Testing ppromt_split_topic_hdbscan...")

        prompt_lis = ["Split topic 0 into subtopics using hdbscan",
                        "Split topic 1 into subtopics using hdbscan",
                        "Split topic 2 into subtopics using hdbscan"]

        for prompt in prompt_lis:

                answer, function_result = self.topicgpt.prompt(prompt)

                print(f"Answer to the prompt '{prompt}' \n is \n '{answer}'")
                print("function_result: ", function_result)

                self.assertTrue(type(answer) == str)
                self.assertTrue(type(function_result) == list)
                self.assertTrue(type(function_result[0]) == Topic)

    def test_prompt_split_topic_hdbscan_inplace(self):
        """
        test the ppromt function that calls split_topic_hdbscan of the TopicPrompting class
        """

        print("Testing ppromt_split_topic_hdbscan...")

        prompt_lis = ["Split topic 4 into subtopics using hdbscan. Do this inplace"]

        for prompt in prompt_lis:

                answer, function_result = self.topicgpt.prompt(prompt)

                print(f"Answer to the prompt '{prompt}' \n is \n '{answer}'")
                print("function_result: ", function_result)

                self.assertTrue(type(answer) == str)
                self.assertTrue(type(function_result) == list)
                self.assertTrue(type(function_result[0]) == Topic)

                print("topic_gpt_topic_list: ", self.topicgpt.topic_lis)
                print("function_result: ", function_result)
                self.assertTrue(self.topicgpt.topic_lis == function_result)

    def test_prompt_split_topic_keywords(self):
         """
         test the prompt function that calls split_topic_keywords of the TopicPrompting class. This test works almost the same as the test_prompt_split_topic_kmeans
         """

         print("Testing ppromt_split_topic_keywords...")

         prompt_lis = ["Split topic 0 into 2 subtopics based on the keywords Technology and Computers",
                        "Split topic 14 into two subbtopics based on the keywords Space and Exploration"]

         added_topic_lis_len  = [2, 2]   
         for prompt, added_topic_len in zip(prompt_lis, added_topic_lis_len):

                answer, function_result = self.topicgpt.prompt(prompt)

                print(f"Answer to the prompt '{prompt}' \n is \n '{answer}'")
                print("function_result: ", function_result)

                self.assertTrue(type(answer) == str)
                self.assertTrue(type(function_result) == list)
                print(type(function_result[0]))
                self.assertTrue(type(function_result[0]) == Topic)
                self.assertTrue(len(function_result) == added_topic_len + len(self.topicgpt.topic_lis) -1 )

    def test_prompt_split_topic_keywords_inplace(self):
            """
            test the prompt function that calls split_topic_keywords of the TopicPrompting class. This test works almost the same as the test_prompt_split_topic_kmeans
            """

            print("Testing ppromt_split_topic_keywords...")

            prompt_lis = ["Split topic 13 into 2 subtopics based on the keywords 'Rocket and 'Milky Way'. Do this inplace"]

            added_topic_lis_len  = [2]   
            old_number_of_topics = len(self.topicgpt.topic_lis)
            for prompt, added_topic_len in zip(prompt_lis, added_topic_lis_len):

                    answer, function_result = self.topicgpt.prompt(prompt)

                    print(f"Answer to the prompt '{prompt}' \n is \n '{answer}'")
                    print("function_result: ", function_result)

                    self.assertTrue(type(answer) == str)
                    self.assertTrue(type(function_result) == list)
                    self.assertTrue(type(function_result[0]) == Topic)

                    self.assertTrue(len(self.topicgpt.topic_lis) == old_number_of_topics + added_topic_len - 1)
                    self.assertTrue(self.topicgpt.topic_lis == function_result)

    def test_prompt_split_topic_single_keyword(self):
         """
         test the prompt function that calls split_topic_keywords of the TopicPrompting class. This test works almost the same as the test_prompt_split_topic_kmeans
         """

         print("Testing ppromt_split_topic_keywords...")

         prompt_lis = ["Split topic into two topics using the additional keyword 'Technology'",
                        "Split topic into two topics using the additional keyword 'Space'"]

         added_topic_lis_len  = [2, 2]

         for prompt, added_topic_len in zip(prompt_lis, added_topic_lis_len):
                    answer, function_result = self.topicgpt.prompt(prompt)

                    print(f"Answer to the prompt '{prompt}' \n is \n '{answer}'")
                    print("function_result: ", function_result)

                    self.assertTrue(type(answer) == str)
                    self.assertTrue(type(function_result) == list)
                    self.assertTrue(type(function_result[0]) == Topic)
                    self.assertTrue(len(function_result) == added_topic_len + len(self.topicgpt.topic_lis) -1 )

    def test_prompt_split_topic_single_keyword_inplace(self):
            """
            test the prompt function that calls split_topic_keywords of the TopicPrompting class. This test works almost the same as the test_prompt_split_topic_kmeans
            """

            print("Testing ppromt_split_topic_keywords...")

            prompt_lis = ["Split topic 0 into 2 subtopics based on the keywords Technology and Computers. Do this inplace"]

            added_topic_lis_len  = [2]   
            old_number_of_topics = len(self.topicgpt.topic_lis)
            for prompt, added_topic_len in zip(prompt_lis, added_topic_lis_len):

                    answer, function_result = self.topicgpt.prompt(prompt)

                    print(f"Answer to the prompt '{prompt}' \n is \n '{answer}'")
                    print("function_result: ", function_result)

                    self.assertTrue(type(answer) == str)
                    self.assertTrue(type(function_result) == list)
                    self.assertTrue(type(function_result[0]) == Topic)

                    self.assertTrue(len(self.topicgpt.topic_lis) == old_number_of_topics + added_topic_len -1 )
                    self.assertTrue(self.topicgpt.topic_lis == function_result)

    def test_prompt_combine_topics(self):
        """
        test the prompt function that calls combine_topics of the TopicPrompting class
        """

        print("Testing ppromt_combine_topics...")

        prompt_lis = ["Combine topic 0 and topic 1 into one topic",
                        "Combine topic 1 and topic 2 into one topic",
                        "Combine topic 2 and topic 3 into one topic"]

        for prompt in prompt_lis:

                answer, function_result = self.topicgpt.prompt(prompt)

                print(f"Answer to the prompt '{prompt}' \n is \n '{answer}'")
                print("function_result: ", function_result)

                self.assertTrue(type(answer) == str)
                self.assertTrue(type(function_result) == list)
                self.assertTrue(type(function_result[0]) == Topic)
                self.assertTrue(len(function_result) == len(self.topicgpt.topic_lis) -1)

    def test_prompt_combine_topics_inplace(self):
        """
        test the prompt function that calls combine_topics of the TopicPrompting class
        """

        print("Testing ppromt_combine_topics...")

        prompt_lis = ["Combine topic 0 and topic 1 into one topic. Do this inplace"]
        old_number_topics = len(self.topicgpt.topic_lis)

        for prompt in prompt_lis:

                answer, function_result = self.topicgpt.prompt(prompt)

                print(f"Answer to the prompt '{prompt}' \n is \n '{answer}'")
                print("function_result: ", function_result)
                print("topic_gpt_topic_list: ", self.topicgpt.topic_lis)

                self.assertTrue(type(answer) == str)
                self.assertTrue(type(function_result) == list)
                self.assertTrue(type(function_result[0]) == Topic)
                self.assertTrue(self.topicgpt.topic_lis == function_result)
                self.assertTrue(len(self.topicgpt.topic_lis) == old_number_topics -1)

    def test_prompt_add_new_topic_keyword(self):
         """
         test the prompt function that calls add_new_topic_keyword of the TopicPrompting class
         """

         print("Testing ppromt_add_new_topic_keyword...")

         prompt_lis = ["Add a new topic with the keyword 'Politics'",
                    "Add a new topic with the keyword 'Climate Change'",
                    "Add a new topic with the keyword 'Computers'"]

         for prompt in prompt_lis:

                answer, function_result = self.topicgpt.prompt(prompt)

                print(f"Answer to the prompt '{prompt}' \n is \n '{answer}'")
                print("function_result: ", function_result)

                self.assertTrue(type(answer) == str)
                self.assertTrue(type(function_result) == list)
                print(type(function_result[0]))
                self.assertTrue(type(function_result[0]) == Topic)
                self.assertTrue(len(function_result) == len(self.topicgpt.topic_lis) +1)

    def test_prompt_add_new_topic_keyword_inplace(self):
        """
        test the prompt function that calls add_new_topic_keyword of the TopicPrompting class
        """

        print("Testing ppromt_add_new_topic_keyword...")

        prompt_lis = ["Add a new topic with the keyword 'Politics'. Do this inplace"]
        old_number_topics = len(self.topicgpt.topic_lis)

        for prompt in prompt_lis:

                answer, function_result = self.topicgpt.prompt(prompt)

                print(f"Answer to the prompt '{prompt}' \n is \n '{answer}'")
                print("function_result: ", function_result)

                self.assertTrue(type(answer) == str)
                self.assertTrue(type(function_result) == list)
                self.assertTrue(type(function_result[0]) == Topic)
                self.assertTrue(self.topicgpt.topic_lis == function_result)
                self.assertTrue(len(self.topicgpt.topic_lis) == old_number_topics +1)

    def test_prompt_delete_topic(self):
        """
        test the prompt function that calls delete_topic of the TopicPrompting class
        """

        print("Testing ppromt_delete_topic...")

        prompt_lis = ["Delete topic 0",
                        "Delete topic 1",
                        "Delete topic 2"]

        for prompt in prompt_lis:

                answer, function_result = self.topicgpt.prompt(prompt)

                print(f"Answer to the prompt '{prompt}' \n is \n '{answer}'")
                print("function_result: ", function_result)

                self.assertTrue(type(answer) == str)
                self.assertTrue(type(function_result) == list)
                self.assertTrue(type(function_result[0]) == Topic)
                self.assertTrue(len(function_result) == len(self.topicgpt.topic_lis) -1)

    def test_prompt_delete_topic_inplace(self):
        """
        test the prompt function that calls delete_topic of the TopicPrompting class
        """

        print("Testing ppromt_delete_topic...")

        prompt_lis = ["Delete topic 0. Do this inplace"]
        old_number_topics = len(self.topicgpt.topic_lis)

        for prompt in prompt_lis:

                answer, function_result = self.topicgpt.prompt(prompt)

                print(f"Answer to the prompt '{prompt}' \n is \n '{answer}'")
                print("function_result: ", function_result)

                self.assertTrue(type(answer) == str)
                self.assertTrue(type(function_result) == list)
                self.assertTrue(type(function_result[0]) == Topic)
                self.assertTrue(self.topicgpt.topic_lis == function_result)
                self.assertTrue(len(self.topicgpt.topic_lis) == old_number_topics -1)

    def test_prompt_get_topic_information(self):
         """
         test the get_topic_information function of the TopicGPT class
         """

         print("Testing get_topic_information...")

         prompt_lis = ["Please compare topic 0 and topic 1",
                    "Please compare topic 3,4,5"]

         for prompt in prompt_lis:

                answer, function_result = self.topicgpt.prompt(prompt)

                print(f"Answer to the prompt '{prompt}' \n is \n '{answer}'")
                print("function_result: ", function_result)

                self.assertTrue(type(answer) == str)
                self.assertTrue(type(function_result) == dict) 

if __name__ == "__main__":
   unittest.main()