From 034d563c47d0dcdfbcafbc22b0261f60e7d6eccb Mon Sep 17 00:00:00 2001 From: pseudo-rnd-thoughts Date: Fri, 30 Jun 2023 11:05:43 +0100 Subject: [PATCH] Remove legacy `MakeFile` and revert adding doctest --- .github/workflows/build.yml | 4 +-- .pre-commit-config.yaml | 2 +- CONTRIBUTING.md | 2 +- Makefile | 69 ------------------------------------- 4 files changed, 4 insertions(+), 73 deletions(-) delete mode 100644 Makefile diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 54837ce43..654b6dd58 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -18,5 +18,5 @@ jobs: --tag metaworld-docker . - name: Run tests run: docker run metaworld-docker pytest tests/* - - name: Run doctests - run: docker run metaworld-docker pytest --doctest-modules metaworld/ +# - name: Run doctests +# run: docker run metaworld-docker pytest --doctest-modules metaworld/ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 798b10a35..87496fce6 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -29,7 +29,7 @@ repos: hooks: - id: flake8 args: - - '--per-file-ignores=*/__init__.py:F401 gymnasium/envs/registration.py:E704 docs/tutorials/*.py:E402 gymnasium/experimental/wrappers/__init__.py:E402' + - '--per-file-ignores=*/__init__.py:F401' - --ignore=E203,W503,E741 - --max-complexity=30 - --max-line-length=456 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5fe7e2400..751148e75 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,7 +12,7 @@ Ensure that your task and pull request: * [ ] Contains meaningful internal variation (e.g. different object positions, etc.) * [ ] Conforms to the action space, observation space, and reward functions conventions used by metaworld environments * [ ] Uses existing assets if they exist, and that any new assets added are high-quality -* [ ] Follows the code qualtiy, style, testing, and documentation guidelines outlined below +* [ ] Follows the code quality, style, testing, and documentation guidelines outlined below * [ ] Provides learning curves which show the task can by solved by PPO and SAC, using the implementations linked below PPO: https://github.com/rlworkgroup/garage/blob/master/src/garage/tf/algos/ppo.py diff --git a/Makefile b/Makefile deleted file mode 100644 index 70800f13e..000000000 --- a/Makefile +++ /dev/null @@ -1,69 +0,0 @@ -SHELL := /bin/bash - -.PHONY: help test ci-job build-ci build-headlessrun-ci run-headless - -.DEFAULT_GOAL := help - -test: ## Run the CI test suite locally -test: RUN_CMD = pytest -v -test: run - @echo "Running test suite..." - -check-memory: ## Profile memory usage -check-memory: RUN_CMD = scripts/profile_memory_usage.py -check-memory: run - @echo "Profiling memory usage..." - -ci-job: - pytest -n 0 --cov=metaworld -v -m 'not large and not skip_on_ci' - coverage xml - # bash <(curl -s https://codecov.io/bash) - -ci-deploy-docker: - echo "${DOCKER_API_KEY}" | docker login -u "${DOCKER_USERNAME}" \ - --password-stdin - docker tag "${TAG}" rlworkgroup/metaworld-ci:latest - docker push rlworkgroup/metaworld-ci - -build-ci: TAG ?= rlworkgroup/metaworld-ci:latest -build-ci: docker/Dockerfile - TAG=${TAG} \ - docker build \ - --cache-from rlworkgroup/metaworld-ci:latest \ - -f docker/Dockerfile \ - -t ${TAG} \ - ${ADD_ARGS} \ - . - -run-ci: TAG ?= rlworkgroup/metaworld-ci -run-ci: - docker run \ - -e TRAVIS_BRANCH \ - -e TRAVIS_PULL_REQUEST \ - -e TRAVIS_COMMIT_RANGE \ - -e TRAVIS \ - -e MJKEY \ - --memory 7500m \ - --memory-swap 7500m \ - ${ADD_ARGS} \ - ${TAG} ${RUN_CMD} - -run: ## Run the Docker container on a local machine -run: CONTAINER_NAME ?= metaworld-ci -run: build-ci - docker run \ - -it \ - --rm \ - --memory 7500m \ - --memory-swap 7500m \ - --name $(CONTAINER_NAME) \ - ${ADD_ARGS} \ - rlworkgroup/metaworld-ci $(RUN_CMD) - -# Help target -# See https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html -help: ## Display this message -help: - @grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) \ - | sort \ - | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'