Describe Team, Added Acknowledgement, adding feature for qradar search

Chanakan5591 · Aug 23, 2024 · 7451c81 · 7451c81
1 parent 0fe1b70
commit 7451c81
Show file tree

Hide file tree

Showing 17 changed files with 37 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -66,7 +66,7 @@ The criteria are based on the following factors:
 - LLMs should be able to understand the context of the external data sources
 - LLMs should be customizable to fit the specific needs of the user
 
-These evaluation results were sourced from the Typhoon LLMs page on Hugging Face, and the results are as follows:
+These evaluation results were sourced from the [Typhoon LLMs page on Hugging Face](https://huggingface.co/scb10x/llama-3-typhoon-v1.5x-70b-instruct), and the results are as follows:
 
 #### Agentic Capabilities
 
@@ -78,8 +78,7 @@ These evaluation results were sourced from the Typhoon LLMs page on Hugging Face
 | ---              | ---                 | ---                  | ---                      |
 | gpt-4o           | 44.73/57.5          | 100/100              | 71.64/76.58              |
 
-And this is from the OpenTyphoon release blog comparing their large model with large proprietary model using Stanford HELM framework
-
+And this is from the [OpenTyphoon release blog](https://blog.opentyphoon.ai/typhoon-1-5-release-a9364cb8e8d7) comparing their large model with large proprietary model using Stanford HELM framework
 
 #### Language & Knowledge Capabilities
 
@@ -89,3 +88,23 @@ And this is from the OpenTyphoon release blog comparing their large model with l
 | OpenThaiGPT 1.0.0 70B      | 0.447 | 0.492 | 0.778 | 0.500  | 0.319   | 0.5072             | 0.493  | 0.6167 |
 | GPT-3.5-turbo (01-2024)     | 0.358 | 0.279 | 0.678 | 0.345  | 0.318   | 0.3956             | 0.316  | 0.700  |
 | GPT-4 (04-2024)            | 0.589 | 0.594 | 0.756 | 0.517  | 0.616   | 0.6144             | 0.626  | 0.864  |
+
+We had concluded that, based on the evaluation results, the Typhoon models (with the larger one use specifically for chat, while the other one for tool-calling) is the best models for our use case, as it has very close agentic capabilities and language & knowledge capabilities to the large proprietary model, for an open model focused on Thai language.
+
+## Acknowledgements
+
+With sincere thanks to:
+
+- [Cynclair](https://cynclair.com/), [Mahidol University International College](https://muic.mahidol.ac.th) for providing us with the opportunity to participate in the hackathon
+- [SCB 10X](https://www.scb10x.com/) for developing the Typhoon models
+- [OpenTyphoon](https://opentyphoon.ai/) for making the Typhoon models API available for public use
+- [Mesop](https://google.github.io/mesop/) for providing the UI framework
+- [Chroma](https://www.trychroma.com/) for the vector database for storing the context of the LLMs
+- [VirusTotal](https://www.virustotal.com/) for being everyone's go-to for checking the reputation of files, URLs, and IP addresses
+- [AbuseIPDB](https://www.abuseipdb.com/) for providing the IP reputation database
+- [QRadar SIEM](https://www.ibm.com/qradar) for providing a simple API access to query SIEM data
+
+We also personally thank:
+
+- **Cynclair Persona and Mentor** for providing us with the information and guidance throughout the hackathon
+- **Our Fellow Hackathon Participants** for providing us with the opportunity to learn from them
diff --git a/cyntelligence/FileAnalyze.py b/cyntelligence/FileAnalyze.py
@@ -3,7 +3,7 @@
 # existing threats
 #
 # Copyright 2024 Chanakan Moongthin <me@chanakancloud.net>
-# on behalf of Up Up Up All Night
+# on behalf of Up Up Up All Night (Team of Cynclair Hackathon 2024)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/cyntelligence/IPEnrich.py b/cyntelligence/IPEnrich.py
@@ -2,7 +2,7 @@
 # IPEnrich module for enriching IP addresses information
 #
 # Copyright 2024 Chanakan Moongthin <me@chanakancloud.net>
-# on behalf of Up Up Up All Night
+# on behalf of Up Up Up All Night (Team of Cynclair Hackathon 2024)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/cyntelligence/MITRESearch.py b/cyntelligence/MITRESearch.py
@@ -2,7 +2,7 @@
 # MITRE module for looking up information from MITRE ATT&CK
 #
 # Copyright 2024 Chanakan Moongthin <me@chanakancloud.net>
-# on behalf of Up Up Up All Night
+# on behalf of Up Up Up All Night (Team of Cynclair Hackathon 2024)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/cyntelligence/QRadarSearch.py b/cyntelligence/QRadarSearch.py
diff --git a/cyntelligence/__init__.py b/cyntelligence/__init__.py
@@ -2,7 +2,7 @@
 # Initialization file for cyntelligence.
 #
 # Copyright 2024 Chanakan Moongthin <me@chanakancloud.net>
-# on behalf of Up Up Up All Night
+# on behalf of Up Up Up All Night (Team of Cynclair Hackathon 2024)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/cyntelligence/common/cache.py b/cyntelligence/common/cache.py
@@ -2,7 +2,7 @@
 # Cache utilities for implementing time-invalidation cache
 #
 # Copyright 2024 Chanakan Moongthin <me@chanakancloud.net>
-# on behalf of Up Up Up All Night
+# on behalf of Up Up Up All Night (Team of Cynclair Hackathon 2024)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/cyntelligence/datasource/BaseSource.py b/cyntelligence/datasource/BaseSource.py
@@ -2,7 +2,7 @@
 # Base Data Source file for implementing data source
 #
 # Copyright 2024 Chanakan Moongthin <me@chanakancloud.net>
-# on behalf of Up Up Up All Night
+# on behalf of Up Up Up All Night (Team of Cynclair Hackathon 2024)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/cyntelligence/datasource/QRadar.py b/cyntelligence/datasource/QRadar.py
@@ -3,7 +3,7 @@
 # via its Ariel API
 #
 # Copyright 2024 Chanakan Moongthin <me@chanakancloud.net>
-# on behalf of Up Up Up All Night
+# on behalf of Up Up Up All Night (Team of Cynclair Hackathon 2024)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/cyntelligence/datasource/__init__.py b/cyntelligence/datasource/__init__.py
@@ -2,7 +2,7 @@
 # Initialization file for datasource module
 #
 # Copyright 2024 Chanakan Moongthin <me@chanakancloud.net>
-# on behalf of Up Up Up All Night
+# on behalf of Up Up Up All Night (Team of Cynclair Hackathon 2024)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/cyntelligence/feature_flags.py b/cyntelligence/feature_flags.py
@@ -2,7 +2,7 @@
 # Feature Flags file for enabling or disabling features
 #
 # Copyright 2024 Chanakan Moongthin <me@chanakancloud.net>
-# on behalf of Up Up Up All Night
+# on behalf of Up Up Up All Night (Team of Cynclair Hackathon 2024)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/cyntelligence/intelsource/AbuseIPDB.py b/cyntelligence/intelsource/AbuseIPDB.py
@@ -3,7 +3,7 @@
 # AbuseIPDB via its API
 #
 # Copyright 2024 Chanakan Moongthin <me@chanakancloud.net>
-# on behalf of Up Up Up All Night
+# on behalf of Up Up Up All Night (Team of Cynclair Hackathon 2024)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/cyntelligence/intelsource/BaseSource.py b/cyntelligence/intelsource/BaseSource.py
@@ -2,7 +2,7 @@
 # Base intelligence source file for implementing intelsource file
 #
 # Copyright 2024 Chanakan Moongthin <me@chanakancloud.net>
-# on behalf of Up Up Up All Night
+# on behalf of Up Up Up All Night (Team of Cynclair Hackathon 2024)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/cyntelligence/intelsource/MITRE.py b/cyntelligence/intelsource/MITRE.py
@@ -3,7 +3,7 @@
 # Data via mitreattack-python
 #
 # Copyright 2024 Chanakan Moongthin <me@chanakancloud.net>
-# on behalf of Up Up Up All Night
+# on behalf of Up Up Up All Night (Team of Cynclair Hackathon 2024)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/cyntelligence/intelsource/VirusTotal.py b/cyntelligence/intelsource/VirusTotal.py
@@ -3,7 +3,7 @@
 # VirusTotal platform via vt-py
 #
 # Copyright 2024 Chanakan Moongthin <me@chanakancloud.net>
-# on behalf of Up Up Up All Night
+# on behalf of Up Up Up All Night (Team of Cynclair Hackathon 2024)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/cyntelligence/intelsource/__init__.py b/cyntelligence/intelsource/__init__.py
@@ -2,7 +2,7 @@
 # Initialization file for intelsource module
 #
 # Copyright 2024 Chanakan Moongthin <me@chanakancloud.net>
-# on behalf of Up Up Up All Night
+# on behalf of Up Up Up All Night (Team of Cynclair Hackathon 2024)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/main.py b/main.py
@@ -3,7 +3,7 @@
 # and most of the logic.
 #
 # Copyright 2024 Chanakan Moongthin <me@chanakancloud.net>
-# on behalf of Up Up Up All Night
+# on behalf of Up Up Up All Night (Team of Cynclair Hackathon 2024)
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.