Merge pull request #85 from KarhouTam/dev

refactor(renaming): Rename .environement to .env Erase some comments
KarhouTam · Aug 30, 2024 · de1f863 · de1f863
2 parents d698e15 + e62d620
commit de1f863
Show file tree

Hide file tree

Showing 7 changed files with 8 additions and 10 deletions.
diff --git a/.environment/Dockerfile → .env/Dockerfile b/.environment/Dockerfile → .env/Dockerfile
@@ -7,7 +7,7 @@ RUN apt update && \
 
 WORKDIR /root
 
-COPY .environment/requirements.txt /tmp
+COPY .env/requirements.txt /tmp
 
 RUN pip install --upgrade pip && \
     pip install -r /tmp/requirements.txt

diff --git a/.environment/poetry.lock → .env/poetry.lock b/.environment/poetry.lock → .env/poetry.lock
diff --git a/.environment/pyproject.toml → .env/pyproject.toml b/.environment/pyproject.toml → .env/pyproject.toml
diff --git a/.environment/requirements.txt → .env/requirements.txt b/.environment/requirements.txt → .env/requirements.txt
diff --git a/.github/workflows/docker-publish.yml b/.github/workflows/docker-publish.yml
@@ -3,7 +3,7 @@ name: Docker Image Publish
 on:
   push:
     paths:
-      - ".environment/**"
+      - ".env/**"
       - ".github/workflows/docker-publish.yml"
 
 env:
@@ -34,7 +34,7 @@ jobs:
         uses: docker/build-push-action@v5
         with:
           context: .
-          file: .environment/Dockerfile
+          file: .env/Dockerfile
           push: false
           tags: |
             ${{ env.GITHUB_REGISTRY }}/${{ env.IMAGE_LOWERCASE_OWNER }}/${{ env.IMAGE_LOWERCASE_NAME }}:${{ env.IMAGE_TAG }}
@@ -69,7 +69,7 @@ jobs:
         uses: docker/build-push-action@v5
         with:
           context: .
-          file: .environment/Dockerfile
+          file: .env/Dockerfile
           push: true
           tags: |
             ${{ env.GITHUB_REGISTRY }}/${{ env.IMAGE_LOWERCASE_OWNER }}/${{ env.IMAGE_LOWERCASE_NAME }}:${{ env.IMAGE_TAG }}
@@ -103,7 +103,7 @@ jobs:
         uses: docker/build-push-action@v5
         with:
           context: .
-          file: .environment/Dockerfile
+          file: .env/Dockerfile
           push: true
           tags: |
             ${{ env.ALIYUN_REGISTRY }}/${{ env.IMAGE_LOWERCASE_OWNER }}/${{ env.IMAGE_LOWERCASE_NAME }}:${{ env.IMAGE_TAG }}

diff --git a/README.md b/README.md
@@ -98,17 +98,17 @@ FL-bench welcomes PR on everything that can make this project better.
 
 ### PyPI 🐍
 ```sh
-pip install -r .environment/requirements.txt
+pip install -r .env/requirements.txt
 ```
 
 ### Poetry 🎶
 For those China mainland users
 ```sh
-poetry install --no-root -C .environment
+poetry install --no-root -C .env
 ```
 For others
 ```sh
-cd .environment && sed -i "10,14d" pyproject.toml && poetry lock --no-update && poetry install --no-root
+cd .env && sed -i "10,14d" pyproject.toml && poetry lock --no-update && poetry install --no-root
 ```
 
 ### Docker 🐳

diff --git a/config/defaults.yaml b/config/defaults.yaml
@@ -61,12 +61,10 @@ common:
 
 # You can set specific arguments for FL methods also
 # FL-bench uses FL method arguments by args.<method>.<arg>
-# e.g.
 fedprox:
   mu: 0.01
 pfedsim:
   warmup_round: 0.7
-# ...
 
 # NOTE: For those unmentioned arguments, the default values are set in `get_hyperparams()` in `class <method>Server` in `src/server/<method>.py`