Skip to content

Commit

Permalink
Merge pull request #100 from Archaic-Atom/dev
Browse files Browse the repository at this point in the history
fixed all problems
  • Loading branch information
ZhiboRao authored Sep 21, 2024
2 parents f4094af + c17b75e commit 0aa194d
Show file tree
Hide file tree
Showing 4 changed files with 181 additions and 216 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: "CodeQL"

on:
push:
branches: [ "master" ]
branches: [ "dev" ]
pull_request:
branches: [ "master" ]
schedule:
Expand Down Expand Up @@ -38,4 +38,4 @@ jobs:
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v2
with:
category: "/language:${{ matrix.language }}"
category: "/language:${{ matrix.language }}"
57 changes: 29 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
[![build test](https://github.com/Archaic-Atom/JackFramework/actions/workflows/build%20test.yml/badge.svg?event=push)](https://github.com/Archaic-Atom/JackFramework/actions/workflows/build%20test.yml)
[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/1996scarlet/Dense-Head-Pose-Estimation.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Archaic-Atom/JackFramework/context:python)
![Python 3.8](https://img.shields.io/badge/python-3.8-green.svg?style=plastic)
![Pytorch 1.7](https://img.shields.io/badge/PyTorch%20-%23EE4C2C.svg?style=plastic)
![cuDnn 7.3.6](https://img.shields.io/badge/cudnn-7.3.6-green.svg?style=plastic)
Expand Down Expand Up @@ -38,7 +37,7 @@ This framework is only used in GPUs.
**1) Build env**
```
$ conda env create -f environment.yml
$ conda activate JackFramework-torch1.7.1
$ conda activate JackFramework-torch2.3.1
```
**2) Install the JackFramework lib**
```
Expand All @@ -56,32 +55,33 @@ you can find the template project in: https://github.com/Archaic-Atom/FameworkTe
you can find the demo project in: https://github.com/Archaic-Atom/Demo-jf

**Related Arguments for training or testing process**
| Args | Type | Description | Default |
|:-------------:|:-------:|:--------------------------------:|:---------------:|
| mode | [str] | train or test | train |
| gpu | [int] | the number of gpus | 2 |
| auto_save_num | [int] | the number of interval save | 1 |
| dataloaderNum | [int] | the number of dataloader | 8 |
| pretrain | [bool] | is a new training process | False |
| ip | [str] | used for distributed training | 127.0.0.1 |
| port | [str] | used for distributed training | 8086 |
| dist | [bool] | distributed training (DDP) | True |
| trainListPath | [str] | the list for training or testing | ./Datasets/*.csv|
| valListPath | [str] | the list for validate process | ./Datasets/*.csv|
| outputDir | [str] | the folder for log file | ./Result/ |
| modelDir | [str] | the folder for saving model | ./Checkpoint/ |
| resultImgDir | [str] | the folder for output | ./ResultImg/ |
| log | [str] | the folder for tensorboard | ./log/ |
| sampleNum | [int] | the number of sample for data | 1 |
| batchSize | [int] | batch size | 4 |
| lr | [float]| learning rate | 0.001 |
| maxEpochs | [int] | training epoch | 30 |
| imgWidth | [int] | the cutting width | 512 |
| imgHeight | [int] | the cutting height | 256 |
| imgNum | [int] | the number of images for training| 35354 |
| valImgNum | [int] | the number of images for val | 200 |
| modelName | [str] | the model's name | NLCA-Net |
| dataset | [str] | the dataset's name | SceneFlow |
| Args | Type | Description | Default |
|:-------------:|:-------:|:--------------------------------:|:--------------------------------:|
| mode | [str] | train or test | train |
| gpu | [int] | the number of gpus | 2 |
| auto_save_num | [int] | the number of interval save | 1 |
| dataloaderNum | [int] | the number of dataloader | 8 |
| pretrain | [bool] | is a new training process | False |
| ip | [str] | used for distributed training | 127.0.0.1 |
| port | [str] | used for distributed training | 8086 |
| dist | [bool] | distributed training (DDP) | True |
| trainListPath | [str] | the list for training or testing | ./Datasets/*.csv |
| valListPath | [str] | the list for validate process | ./Datasets/*.csv |
| outputDir | [str] | the folder for log file | ./Result/ |
| modelDir | [str] | the folder for saving model | ./Checkpoint/ |
| resultImgDir | [str] | the folder for output | ./ResultImg/ |
| log | [str] | the folder for tensorboard | ./log/ |
| sampleNum | [int] | the number of sample for data | 1 |
| batchSize | [int] | batch size | 4 |
| lr | [float]| learning rate | 0.001 |
| maxEpochs | [int] | training epoch | 30 |
| imgWidth | [int] | the cutting width | 512 |
| imgHeight | [int] | the cutting height | 256 |
| imgNum | [int] | the number of images for training| 35354 |
| valImgNum | [int] | the number of images for val | 200 |
| modelName | [str] | the model's name | NLCA-Net |
| dataset | [str] | the dataset's name | SceneFlow |
| web_cmd | [str] | cmd for django | 'main.py runserver 0.0.0.0:8000' |


**5) Clean the project (if you want to clean generating files)**
Expand All @@ -102,6 +102,7 @@ $ ./clean.sh
| | ├── SysBasic/
| | ├── UserTemplate/
| | ├── FileHandler/
| | ├── Web/
│ | └── ...
│ ├── setup.py
│ └── ...
Expand Down
Loading

0 comments on commit 0aa194d

Please sign in to comment.