malwareDetector 0.1.12__tar.gz → 0.1.13__tar.gz

{malwareDetector-0.1.12 → malwaredetector-0.1.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: malwareDetector
-Version: 0.1.12
+Version: 0.1.13
 Summary: Malware detector specification for NTUST isLab
 Author: PO-LIN LAI
 Author-email: bolin8017@gmail.com
@@ -8,50 +8,48 @@ License: MIT
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENCE.txt
+Requires-Dist: numpy
+Requires-Dist: pydantic
 
-malwareDetector
-===============
+# malwareDetector
 
 * Source code: https://github.com/louiskyee/malwareDetector.git
 * Wiki: https://github.com/louiskyee/malwareDetector/wiki
 * PyPI: https://pypi.org/project/malwareDetector/
 
-Description
------------
+## Description
 
 This is a malware detector specification for NTUST isLab.
 The `malwareDetector` is a base class designed for malicious software detection. It enables straightforward utilization of Python's inheritance feature. By inheriting from `malwareDetector` and implementing the required functions, you can achieve your specific goals. Additionally, it offers convenient configuration management. For more detailed instructions, please refer to the [GitHub Wiki](https://github.com/louiskyee/malwareDetector/wiki).
 
-Requirements
-------------
-Tool | Version |Source |
-|---|---|---|
-| Python | `>= 3.10` | https://www.python.org/downloads |
+## Requirements
 
-Installation
-------------
+Tool | Version | Source
+-----|---------|-------
+Python | `>= 3.10` | https://www.python.org/downloads
+
+## Installation
 
 Use the package manager [pip](https://pip.pypa.io/en/stable/) to install `malwareDetector`.
 * Example: `pip install malwareDetector`
 
-Usage
------
+## Usage
 
-### import
-* import class `detector` from `malwareDetector.detector`
-    ```python=
+### Import
+* Import class `detector` from `malwareDetector.detector`
+    ```python
     from malwareDetector.detector import detector
     ```
 
-### Examples:
-```python=
-from malwareDetector.detector import detector
-from typing import Any
+### Example:
+```python
 import numpy as np
+from typing import Any
+from malwareDetector.detector import detector
 
 class subDetector(detector):
-    def __init__(self) -> None:
-        super().__init__()
+    def __init__(self, config_path=None) -> None:
+        super().__init__(config_path)
 
     def extractFeature(self) -> Any:
         return 'This is the implementation of the extractFeature function from the derived class.'
@@ -59,9 +57,22 @@ class subDetector(detector):
     def vectorize(self) -> np.array:
         return 'This is the implementation of the vectorize function from the derived class.'
 
-    def model(self) -> Any:
+    def model(self, training: bool = True) -> Any:
         return 'This is the implementation of the model function from the derived class.'
 
     def predict(self) -> np.array:
         return 'This is the implementation of the predict function from the derived class.'
 ```
+
+## Configuration
+
+The `malwareDetector` uses a configuration system that can be customized through a JSON file or command-line arguments. The default configuration file is `config.json` in the current directory, but you can specify a custom path when initializing the detector.
+
+### Key Configuration Classes:
+
+- `Config`: Stores all external settings for the detector.
+- `PathConfig`: Manages input and output file paths.
+- `FolderConfig`: Handles folder configurations for data storage.
+- `ModelConfig`: Stores model-specific parameters and hyperparameters.
+
+For detailed information on configuration options and usage, please refer to the [GitHub Wiki](https://github.com/louiskyee/malwareDetector/wiki).

{malwareDetector-0.1.12 → malwaredetector-0.1.13}/README.md

@@ -1,46 +1,42 @@
-malwareDetector
-===============
+# malwareDetector
 
 * Source code: https://github.com/louiskyee/malwareDetector.git
 * Wiki: https://github.com/louiskyee/malwareDetector/wiki
 * PyPI: https://pypi.org/project/malwareDetector/
 
-Description
------------
+## Description
 
 This is a malware detector specification for NTUST isLab.
 The `malwareDetector` is a base class designed for malicious software detection. It enables straightforward utilization of Python's inheritance feature. By inheriting from `malwareDetector` and implementing the required functions, you can achieve your specific goals. Additionally, it offers convenient configuration management. For more detailed instructions, please refer to the [GitHub Wiki](https://github.com/louiskyee/malwareDetector/wiki).
 
-Requirements
-------------
-Tool | Version |Source |
-|---|---|---|
-| Python | `>= 3.10` | https://www.python.org/downloads |
+## Requirements
 
-Installation
-------------
+Tool | Version | Source
+-----|---------|-------
+Python | `>= 3.10` | https://www.python.org/downloads
+
+## Installation
 
 Use the package manager [pip](https://pip.pypa.io/en/stable/) to install `malwareDetector`.
 * Example: `pip install malwareDetector`
 
-Usage
------
+## Usage
 
-### import
-* import class `detector` from `malwareDetector.detector`
-    ```python=
+### Import
+* Import class `detector` from `malwareDetector.detector`
+    ```python
     from malwareDetector.detector import detector
     ```
 
-### Examples:
-```python=
-from malwareDetector.detector import detector
-from typing import Any
+### Example:
+```python
 import numpy as np
+from typing import Any
+from malwareDetector.detector import detector
 
 class subDetector(detector):
-    def __init__(self) -> None:
-        super().__init__()
+    def __init__(self, config_path=None) -> None:
+        super().__init__(config_path)
 
     def extractFeature(self) -> Any:
         return 'This is the implementation of the extractFeature function from the derived class.'
@@ -48,9 +44,22 @@ class subDetector(detector):
     def vectorize(self) -> np.array:
         return 'This is the implementation of the vectorize function from the derived class.'
 
-    def model(self) -> Any:
+    def model(self, training: bool = True) -> Any:
         return 'This is the implementation of the model function from the derived class.'
 
     def predict(self) -> np.array:
         return 'This is the implementation of the predict function from the derived class.'
-```
+```
+
+## Configuration
+
+The `malwareDetector` uses a configuration system that can be customized through a JSON file or command-line arguments. The default configuration file is `config.json` in the current directory, but you can specify a custom path when initializing the detector.
+
+### Key Configuration Classes:
+
+- `Config`: Stores all external settings for the detector.
+- `PathConfig`: Manages input and output file paths.
+- `FolderConfig`: Handles folder configurations for data storage.
+- `ModelConfig`: Stores model-specific parameters and hyperparameters.
+
+For detailed information on configuration options and usage, please refer to the [GitHub Wiki](https://github.com/louiskyee/malwareDetector/wiki).

{malwareDetector-0.1.12 → malwaredetector-0.1.13}/malwareDetector/config.py

@@ -39,11 +39,8 @@ class PathConfig(BaseModel, extra=Extra.allow):
 
 class ModelConfig(BaseModel, extra=Extra.allow):
     '''
-    The `ModelConfig` class stores the
-    hyperparameters of model for the detector,
-    which are obtained from `parameter_parser()`.
-    If no additional settings are provided,
-    default values will be used.
+    The `ModelConfig` class is designed to store the
+    parameters and hyperparameters for the detector model.
 
     If you wish to create a customized parameter,
     there has two methods to do it.
@@ -51,15 +48,6 @@ class ModelConfig(BaseModel, extra=Extra.allow):
     method of the `ModelConfig` class.
     2. directly set the parameter in the `config.json` file.
     '''
-    modelName: str = DEFAULT_MODEL_NAME
-    dimensions: int = DEFAULT_DIMENSIONS
-    workers: int = DEFAULT_WORKERS
-    epochs: int = DEFAULT_EPOCHS
-    min_count: int = DEFAULT_MIN_COUNT
-    wl_iterations: int = DEFAULT_WL_ITERATIONS
-    learning_rate: float = DEFAULT_LEARNING_RATE
-    down_sampling: float = DEFAULT_DOWN_SAMPLING
-
     def set_param(self, __name: str, __value: Any):
         if hasattr(self, __name):
             raise AttributeError(f"Parameter {__name} already exists.")
@@ -192,62 +180,6 @@ def parameter_parser(config: Config) -> Config:
                         default=DEFAULT_CONFIG_PATH,
                         help="Configuration file path.")
 
-    parser.add_argument("--dimensions",
-                        dest="dimensions",
-                        type=int,
-                        default=DEFAULT_DIMENSIONS,
-                        help="Number of dimensions. Default is 128."
-                        )
-
-    parser.add_argument("--workers",
-                        dest="workers",
-                        type=int,
-                        default=DEFAULT_WORKERS,
-                        help="Number of workers. Default is 4."
-                        )
-
-    parser.add_argument("--epochs",
-                        dest="epochs",
-                        type=int,
-                        default=DEFAULT_EPOCHS,
-                        help="Number of epochs. Default is 10."
-                        )
-
-    parser.add_argument("--min-count",
-                        dest="min_count",
-                        type=int,
-                        default=DEFAULT_MIN_COUNT,
-                        help="Minimal structural feature count. Default is 5."
-                        )
-
-    parser.add_argument("--wl-iterations",
-                        dest="wl_iterations",
-                        type=int,
-                        default=DEFAULT_WL_ITERATIONS,
-                        help="Number of Weisfeiler-Lehman iterations. Default is 2."
-                        )
-
-    parser.add_argument("--learning-rate",
-                        dest="learning_rate",
-                        type=float,
-                        default=DEFAULT_LEARNING_RATE,
-                        help="Initial learning rate. Default is 0.025."
-                        )
-
-    parser.add_argument("--down-sampling",
-                        dest="down_sampling",
-                        type=float,
-                        default=DEFAULT_DOWN_SAMPLING,
-                        help="Down sampling rate of features. Default is 0.0001."
-                        )
-
-    parser.add_argument('--model','-m',
-                        dest="model",
-                        nargs='?',
-                        default=DEFAULT_MODEL_NAME,
-                        help='Select the model(KNN, LR, MLP, RF, SVM).'
-                        )
-
     parser.add_argument('--classify', '-f',
                         dest="classify",
                         action='store_true',
@@ -259,14 +191,6 @@ def parameter_parser(config: Config) -> Config:
     config.path.input = args.input_path
     config.path.output = args.output_path
     config.path.config = args.config_path
-    config.model.dimensions = args.dimensions
-    config.model.workers = args.workers
-    config.model.epochs = args.epochs
-    config.model.min_count = args.min_count
-    config.model.wl_iterations = args.wl_iterations
-    config.model.learning_rate = args.learning_rate
-    config.model.down_sampling = args.down_sampling
-    config.model.modelName = args.model
     config.classify = args.classify
 
     return config

malwaredetector-0.1.13/malwareDetector/const.py

@@ -0,0 +1,14 @@
+'''
+Save the variables of the system's default constants.
+'''
+
+DEFAULT_INPUT_PATH="./Dataset/program"
+DEFAULT_OUT_PATH="./Predict/predict.json"
+DEFAULT_CONFIG_PATH="./config.json"
+DEFAULT_CLASSIFY=False
+
+DATASET_DIR="./Dataset/"
+FEATURE_DIR="./Feature/"
+VECTORIZE_DIR="./Vectorize/"
+MODEL_DIR="./Model/"
+PREDICT_DIR="./Predict/"

{malwareDetector-0.1.12 → malwaredetector-0.1.13}/malwareDetector/detector.py

@@ -1,15 +1,19 @@
 import os
 import numpy as np
+
 from typing import Any
 from .config import read_config
 from .utils import platform_info
+from .const import DEFAULT_CONFIG_PATH
 
 class detector(object):
-    def __init__(self) -> None:
+    def __init__(self, config_path=None) -> None:
         '''
         read config.json by `read_config` function in `config.py`
         '''
-        self.config = read_config()
+        if config_path is None:
+            config_path = DEFAULT_CONFIG_PATH
+        self.config = read_config(config_path)
 
     def extractFeature(self) -> Any:
         '''

{malwareDetector-0.1.12 → malwaredetector-0.1.13}/malwareDetector.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: malwareDetector
-Version: 0.1.12
+Version: 0.1.13
 Summary: Malware detector specification for NTUST isLab
 Author: PO-LIN LAI
 Author-email: bolin8017@gmail.com
@@ -8,50 +8,48 @@ License: MIT
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENCE.txt
+Requires-Dist: numpy
+Requires-Dist: pydantic
 
-malwareDetector
-===============
+# malwareDetector
 
 * Source code: https://github.com/louiskyee/malwareDetector.git
 * Wiki: https://github.com/louiskyee/malwareDetector/wiki
 * PyPI: https://pypi.org/project/malwareDetector/
 
-Description
------------
+## Description
 
 This is a malware detector specification for NTUST isLab.
 The `malwareDetector` is a base class designed for malicious software detection. It enables straightforward utilization of Python's inheritance feature. By inheriting from `malwareDetector` and implementing the required functions, you can achieve your specific goals. Additionally, it offers convenient configuration management. For more detailed instructions, please refer to the [GitHub Wiki](https://github.com/louiskyee/malwareDetector/wiki).
 
-Requirements
-------------
-Tool | Version |Source |
-|---|---|---|
-| Python | `>= 3.10` | https://www.python.org/downloads |
+## Requirements
 
-Installation
-------------
+Tool | Version | Source
+-----|---------|-------
+Python | `>= 3.10` | https://www.python.org/downloads
+
+## Installation
 
 Use the package manager [pip](https://pip.pypa.io/en/stable/) to install `malwareDetector`.
 * Example: `pip install malwareDetector`
 
-Usage
------
+## Usage
 
-### import
-* import class `detector` from `malwareDetector.detector`
-    ```python=
+### Import
+* Import class `detector` from `malwareDetector.detector`
+    ```python
     from malwareDetector.detector import detector
     ```
 
-### Examples:
-```python=
-from malwareDetector.detector import detector
-from typing import Any
+### Example:
+```python
 import numpy as np
+from typing import Any
+from malwareDetector.detector import detector
 
 class subDetector(detector):
-    def __init__(self) -> None:
-        super().__init__()
+    def __init__(self, config_path=None) -> None:
+        super().__init__(config_path)
 
     def extractFeature(self) -> Any:
         return 'This is the implementation of the extractFeature function from the derived class.'
@@ -59,9 +57,22 @@ class subDetector(detector):
     def vectorize(self) -> np.array:
         return 'This is the implementation of the vectorize function from the derived class.'
 
-    def model(self) -> Any:
+    def model(self, training: bool = True) -> Any:
         return 'This is the implementation of the model function from the derived class.'
 
     def predict(self) -> np.array:
         return 'This is the implementation of the predict function from the derived class.'
 ```
+
+## Configuration
+
+The `malwareDetector` uses a configuration system that can be customized through a JSON file or command-line arguments. The default configuration file is `config.json` in the current directory, but you can specify a custom path when initializing the detector.
+
+### Key Configuration Classes:
+
+- `Config`: Stores all external settings for the detector.
+- `PathConfig`: Manages input and output file paths.
+- `FolderConfig`: Handles folder configurations for data storage.
+- `ModelConfig`: Stores model-specific parameters and hyperparameters.
+
+For detailed information on configuration options and usage, please refer to the [GitHub Wiki](https://github.com/louiskyee/malwareDetector/wiki).

{malwareDetector-0.1.12 → malwaredetector-0.1.13}/setup.py

@@ -11,7 +11,7 @@ required_packages = [
 setup(
     name='malwareDetector',
     packages=find_packages(include=['malwareDetector']),
-    version='0.1.12',
+    version='0.1.13',
     description='Malware detector specification for NTUST isLab',
     long_description=long_description,
     long_description_content_type="text/markdown",

malwareDetector-0.1.12/malwareDetector/const.py

@@ -1,22 +0,0 @@
-'''
-Save the variables of the system's default constants.
-'''
-
-DEFAULT_INPUT_PATH="./Dataset/malware"
-DEFAULT_OUT_PATH="./Feature/feature.csv"
-DEFAULT_CONFIG_PATH="./config.json"
-DEFAULT_MODEL_NAME="SVM"
-DEFAULT_DIMENSIONS=128
-DEFAULT_WORKERS=4
-DEFAULT_EPOCHS=50
-DEFAULT_MIN_COUNT=1
-DEFAULT_WL_ITERATIONS=2
-DEFAULT_LEARNING_RATE=0.025
-DEFAULT_DOWN_SAMPLING=0.0001
-DEFAULT_CLASSIFY=False
-
-DATASET_DIR="./Dataset/"
-FEATURE_DIR="./Feature/"
-VECTORIZE_DIR="./Vectorize/"
-MODEL_DIR="./Model/"
-PREDICT_DIR="./Predict/"