diff --git a/.gitignore b/.gitignore new file mode 100755 index 0000000..3d17a8d --- /dev/null +++ b/.gitignore @@ -0,0 +1,11 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +## do not push heavy files which are created during training to github +datasets/ +results/ diff --git a/README.md b/README.md index 3a29c98..b31a2b1 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,31 @@ -# weightmatrices creation for initialising the first layer of a neural network +# Creation for weight matrices for initialising the first layer of a neural network ## Dependencies & Environment - Conda needs to be installed - Setup the conda environment `weightmatrices` by running: - ```bash + ``` bash setup_dependencies.sh ``` ## Usage - To run the main script(s) that produce the weight matrices run: - ``` bash + ``` bash run.sh ``` + If you want to run specific scripts, do not forget to activate the environment by running: - ``` bash + ``` conda activate weightmatrices ``` ## Remarks By default, Datasets are downloaded and put into a /datasets directory. To avoid this you can: 1. Change the root variable in the torchvision data loader function. 2. Create the /datasets folder and corresponding subfolder and put the datasets (or a link) in there.