Merge pull request #1 from aalramadan/develop

Develop

Author: aalramadan

README.md

@@ -1,39 +1,34 @@
-# **SubGPT v1.0.0**
-<img width="943" alt="image" src="https://github.com/aalramadan/SubGPT/assets/55710790/81404e39-a31a-4b3f-b40e-0cf52e03851e">
+# **🛠 SubGPT**
+![alt text](image.png)
 
-## **What does it do?**
-**SubGPT** provides translations for *multiple* languages using ChatGPT. 
+## **💡What does it do?**
+**SubGPT** provides translations for multiple languages using OpenAI's GPT. 
 
 ## **ChatGPT Models Supported**
 
-- **gpt-3.5-turbo**
-- **gpt-4**
-
+- **GPT 4o**
+- **GPT 4 Turbo**
+- **GPT 4**
+- **GPT 3 Turbo**
 
 ## **Features**
 
-- **SubGPT** provides an option to specify the number of maximum input *tokens*. Higher number could lead to a better translation accuracy. Use according to your rate limit and subscription.
+- You can specify the number of **input tokens**.
 
-- You can *pause/resume* translation at any point.
+- You can **pause/resume** translation at any point.
 
-- You can *remove* and/or *edit* the translated output and the input. The tool will automatically align the non-empty rows.
+- You can **remove** and/or **edit** the translated output and the input. The tool will automatically align the rows.
 
 - Final output along with the modifications can be saved as an *.srt*
 
-## **Experimental**
-- SubGPT utilizes cosine similarity to compare the word embeddings between the input and final output using the *text-embedding-ada-002* model. A threshold between [-1, 1] where 1 indicates total semantic similarity and -1 indicates to semantic similarity at all.
-
-- Higher tokens could lead to high translation accuracy, but may lead to incorrect alignments between the input and output. This option can fix the problem at the expense of using more tokens and time.
+- **SubGPT** utilizes cosine similarity to compare the word embeddings between the input and final output using the *text-embedding-ada-002* model. A threshold between [0, 1] where 1 indicates total semantic similarity and 0 indicates to semantic similarity at all.
 
 
 ## **Demo**
-![Animation](https://github.com/aalramadan/SubGPT/assets/55710790/529fc1c0-91a8-47f8-bee5-664a17b675ba)
-
-
-## **Contribution**
-You can open an issue to discuss any errors or bugs or for general enhancements and suggestions.
+![Animation](https://github.com/aalramadan/SubGPT/assets/55710790/c465d7e4-5c1a-42ef-bc70-2a1ee7c3c25c)
 
 ## **Disclaimer**
-The SubGPT tool is an *experimental* tool provided for informational and educational purposes only. The accuracy and completeness of the output cannot be guaranteed. 
+**SubGPT** is part of a collaborative research funded by the Arab Observatory for Translation (an affiliate of ALECSO), which is supported by the Literature, Publishing & Translation Commission in Saudi Arabia. </br>
 
-SubGPT is part of a collaborative research between *Ali Al-Ramadan* and *Hussein Abu-Rayyash* to provide not only accurate but culturally nuanced translations using cosine similarity.
+> A research paper detailing this work was published at the **International Journal of Linguistics, Literature and Translation** and is available at:</br>
+https://al-kindipublisher.com/index.php/ijllt/article/view/7340/6298

build.txt

@@ -0,0 +1,73 @@
+; Script generated by the Inno Setup Script Wizard.
+; SEE THE DOCUMENTATION FOR DETAILS ON CREATING INNO SETUP SCRIPT FILES!
+
+#define MyAppName "SubGPT"
+#define MyAppVersion "1.1.0"
+#define MyAppExeName "SubGPT.exe"
+#define MyAppAssocName MyAppName + " File"
+#define MyAppAssocExt ".myp"
+#define MyAppAssocKey StringChange(MyAppAssocName, " ", "") + MyAppAssocExt
+
+[Setup]
+; NOTE: The value of AppId uniquely identifies this application. Do not use the same AppId value in installers for other applications.
+; (To generate a new GUID, click Tools | Generate GUID inside the IDE.)
+AppId={{6E5540FA-FE20-43AD-A6D2-CF10E19A0FB3}
+AppName={#MyAppName}
+AppVersion={#MyAppVersion}
+AppVerName={#MyAppName} {#MyAppVersion}
+DefaultDirName={autopf}\{#MyAppName}
+
+; Specifies that Setup cannot run on anything but x64 and Windows 11 on Arm.
+ArchitecturesAllowed=x64compatible
+
+; Requests that the install be done in "64-bit mode" on x64 or Windows 11 on Arm,
+; meaning it should use the native 64-bit Program Files directory and
+; the 64-bit view of the registry.
+ArchitecturesInstallIn64BitMode=x64compatible
+
+ChangesAssociations=yes
+DisableProgramGroupPage=yes
+OutputBaseFilename=mysetup
+Compression=lzma
+SolidCompression=yes
+WizardStyle=modern
+
+; Run in non administrative install mode (install for current user only.)
+PrivilegesRequired=lowest 
+
+SetupIconFile="C:\Users\Ali\Desktop\SubGPT\images\images\title_bar_icon_original.ico"
+
+; Used to display version in installer properties
+VersionInfoVersion={#MyAppVersion}
+UninstallDisplayIcon="C:\Users\Ali\Desktop\SubGPT\images\images\title_bar_icon_original.ico"
+AppPublisher=aalramadan
+
+
+[Languages]
+Name: "english"; MessagesFile: "compiler:Default.isl"
+
+[Tasks]
+Name: "desktopicon"; Description: "{cm:CreateDesktopIcon}"; GroupDescription: "{cm:AdditionalIcons}"; Flags: unchecked
+
+[Files]
+Source: "C:\Users\Ali\Desktop\SubGPT\dist\main\{#MyAppExeName}"; DestDir: "{app}"; Flags: ignoreversion
+Source: "C:\Users\Ali\Desktop\SubGPT\dist\main\_internal\*"; DestDir: "{app}\_internal"; Flags: ignoreversion recursesubdirs createallsubdirs
+; NOTE: Don't use "Flags: ignoreversion" on any shared system files
+
+[Registry]
+Root: HKA; Subkey: "Software\Classes\{#MyAppAssocExt}\OpenWithProgids"; ValueType: string; ValueName: "{#MyAppAssocKey}"; ValueData: ""; Flags: uninsdeletevalue
+Root: HKA; Subkey: "Software\Classes\{#MyAppAssocKey}"; ValueType: string; ValueName: ""; ValueData: "{#MyAppAssocName}"; Flags: uninsdeletekey
+Root: HKA; Subkey: "Software\Classes\{#MyAppAssocKey}\DefaultIcon"; ValueType: string; ValueName: ""; ValueData: "{app}\{#MyAppExeName},0"
+Root: HKA; Subkey: "Software\Classes\{#MyAppAssocKey}\shell\open\command"; ValueType: string; ValueName: ""; ValueData: """{app}\{#MyAppExeName}"" ""%1"""
+Root: HKA; Subkey: "Software\Classes\Applications\{#MyAppExeName}\SupportedTypes"; ValueType: string; ValueName: ".myp"; ValueData: ""
+
+[Icons]
+Name: "{autoprograms}\{#MyAppName}"; Filename: "{app}\{#MyAppExeName}"
+Name: "{autodesktop}\{#MyAppName}"; Filename: "{app}\{#MyAppExeName}"; Tasks: desktopicon
+
+[Run]
+Filename: "{app}\{#MyAppExeName}"; Description: "{cm:LaunchProgram,{#StringChange(MyAppName, '&', '&&')}}"; Flags: nowait postinstall skipifsilent runasoriginaluser 
+
+
+
+

compile/Inno_Setup_Script.iss

@@ -0,0 +1,69 @@
+Build (Windows):
+pyinstaller --windowed --hidden-import=tiktoken_ext.openai_public --hidden-import=tiktoken_ext --icon="C:\Users\Ali\Desktop\SubGPT\images\images\title_bar_icon_original.ico" main.py
+
+* Use for debugging --> --console instead of --windowed 
+
+#################################################################################
+Python packages used:
+annotated-types              0.7.0
+anyio                        4.4.0
+cachetools                   5.3.3
+certifi                      2024.6.2
+charset-normalizer           3.3.2
+colorama                     0.4.6
+contourpy                    1.2.1
+cycler                       0.12.1
+distro                       1.9.0
+fonttools                    4.53.0
+google-ai-generativelanguage 0.6.5
+google-api-core              2.19.0
+google-api-python-client     2.134.0
+google-auth                  2.30.0
+google-auth-httplib2         0.2.0
+google-generativeai          0.7.0
+googleapis-common-protos     1.63.1
+grpcio                       1.64.1
+grpcio-status                1.62.2
+h11                          0.14.0
+httpcore                     1.0.5
+httplib2                     0.22.0
+httpx                        0.27.0
+idna                         3.7
+joblib                       1.4.2
+kiwisolver                   1.4.5
+matplotlib                   3.9.0
+numpy                        2.0.0
+openai                       1.35.3
+packaging                    24.1
+pandas                       2.2.2
+pillow                       10.3.0
+pip                          24.1
+proto-plus                   1.24.0
+protobuf                     4.25.3
+pyasn1                       0.6.0
+pyasn1_modules               0.4.0
+pydantic                     2.7.4
+pydantic_core                2.18.4
+pyparsing                    3.1.2
+PySide6                      6.7.2
+PySide6_Addons               6.7.2
+PySide6_Essentials           6.7.2
+python-dateutil              2.9.0.post0
+pytz                         2024.1
+qasync                       0.27.1
+regex                        2024.5.15
+requests                     2.32.3
+rsa                          4.9
+scikit-learn                 1.5.0
+scipy                        1.13.1
+shiboken6                    6.7.2
+six                          1.16.0
+sniffio                      1.3.1
+srt                          3.5.3
+threadpoolctl                3.5.0
+tiktoken                     0.7.0
+tqdm                         4.66.4
+typing_extensions            4.12.2
+tzdata                       2024.1
+uritemplate                  4.1.1
+urllib3                      2.2.2

compile/build.txt

@@ -4,7 +4,6 @@
 from qasync import QEventLoop
 import ui_functions 
 import asyncio
-import ctypes
 
 class MainWindow(QMainWindow, Ui_MainWindow):
     def __init__(self):
@@ -19,24 +18,17 @@ def __init__(self):
 
         self.btn_open.clicked.connect(lambda: ui_functions.load_template_file(self))
         self.btn_save.clicked.connect(lambda: ui_functions.save_template_file(self))
-        
         self.btn_next.clicked.connect(lambda: ui_functions.check_inputs(self))
-        
         self.btn_start.clicked.connect(lambda: ui_functions.communicate_with_api(self))    
-
         self.btn_back.clicked.connect(lambda: ui_functions.button_click(self, self.btn_back))    
         self.btn_settings.clicked.connect(lambda: ui_functions.expand_settings(self))
         self.data_table.itemSelectionChanged.connect(lambda: ui_functions.items_selected(self))
         self.btn_delete_row.clicked.connect(lambda: ui_functions.delete_row(self))
         self.btn_info.clicked.connect(lambda: ui_functions.expand_about(self))
         self.box_cosine.stateChanged.connect(lambda: ui_functions.on_box_cosine_changed(self, self.box_cosine))
+        
 if __name__ == "__main__":
     app = QApplication()
-    app.setStyle('Fusion')
-
-    # Needed to make Windows use an icon for SubGPT in the taskbar
-    myappid = 'SubGPT.version.1.0'  
-    ctypes.windll.shell32.SetCurrentProcessExplicitAppUserModelID(myappid)
 
     loop = QEventLoop(app) 
     asyncio.set_event_loop(loop)