Update to v0.5.0

Update python package and documentation from v0.4.2 to v0.5.0

[ committed by @mellis13 ]
[ reviewed by @ashao ]

Author: mellis13

.github/workflows/build_docs.yml

@@ -55,12 +55,12 @@ jobs:
           cp -r doc-branch/docs/* ./docs/
           rm -rf doc-branch
 
-      - name: build documentation with docker
+      - name: Build documentation with docker
         run: make docks
 
       - name: Commit files
         run: |
-          git add -A
+          git add -Af
           git config --local user.email "action@github.com"
           git config --local user.name "GitHub Action"
           git commit -m "Update develop documentation"

.github/workflows/release.yml

@@ -53,7 +53,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-20.04, macos-10.15]
+        os: [ubuntu-20.04, macos-12]
 
     steps:
       - uses: actions/checkout@v2
@@ -123,4 +123,4 @@ jobs:
         with:
           user: __token__
           password: ${{ secrets.PYPI }}
-          #repository_url: https://test.pypi.org/legacy/
+          #repository_url: https://test.pypi.org/legacy/

.github/workflows/run_tests.yml

@@ -49,13 +49,13 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [macos-10.15, ubuntu-20.04] # Operating systems
+        os: [macos-12, ubuntu-20.04] # Operating systems
         compiler: [8] # GNU compiler version
         rai: [1.2.5, 1.2.7] # Redis AI versions
         py_v: [3.8, 3.9, '3.10'] # Python versions
         exclude:
           # Do not build with Redis AI 1.2.5 on MacOS
-          - os: macos-10.15
+          - os: macos-12
             rai: 1.2.5
           # Do not build Redis AI 1.2.5 with py3.10
           # as wheels for dependecies are not availble
@@ -128,3 +128,10 @@ jobs:
         with:
           fail_ci_if_error: true
           files: ./coverage.xml
+
+      - name: Run mypy
+        # TF 2.6.2 has a dep conflict with new mypy versions
+        if: (matrix.rai != '1.2.5')
+        run: |
+          python -m pip install .[mypy]
+          make check-mypy

.gitignore

@@ -7,6 +7,7 @@ __pycache__
 htmlcov
 smartsim.egg-info
 tests/test_output
+docs/*
 
 # Dependencies
 smartsim/_core/.third-party

.wci.yml

@@ -22,8 +22,8 @@
     language: Python
 
     release:
-      version: 0.4.2
-      date: 2023-04-12
+      version: 0.5.0
+      date: 2023-07-06
 
     documentation:
       general: https://www.craylabs.org/docs/overview.html

MANIFEST.in

@@ -1,4 +1,3 @@
-include requirements.txt
 include Makefile
 graft smartsim/
 

Makefile

@@ -107,6 +107,12 @@ check-lint:
 	@pylint --rcfile=.pylintrc ./smartsim
 
 
+# help: check-mypy                     - run static type check
+.PHONY: check-mypy
+check-mypy:
+	@mypy --config-file=./pyproject.toml
+
+
 # help:
 # help: Documentation
 # help: -------

README.md

@@ -99,8 +99,8 @@ before using it on your system. Each tutorial is a Jupyter notebook that can be
 which will run a jupyter lab with the tutorials, SmartSim, and SmartRedis installed.
 
 ```bash
-docker pull ghcr.io/craylabs/smartsim-tutorials:v0.4.2
-docker run -p 8888:8888 ghcr.io/craylabs/smartsim-tutorials:v0.4.2
+docker pull ghcr.io/craylabs/smartsim-tutorials:v0.4.1
+docker run -p 8888:8888 ghcr.io/craylabs/smartsim-tutorials:v0.4.1
 # click on link to open jupyter lab
 ```
 
@@ -452,7 +452,7 @@ which will run a jupyter lab with the tutorials, SmartSim, and SmartRedis instal
 
 ```bash
 docker pull ghcr.io/craylabs/smartsim-tutorials:v1
-docker run -p 8888:8888 ghcr.io/craylabs/smartsim-tutorials:v0.4.2
+docker run -p 8888:8888 ghcr.io/craylabs/smartsim-tutorials:v0.4.1
 ```
 Each of the following examples can be found in the
 [SmartSim documentation](https://www.craylabs.org/docs/tutorials/getting_started/getting_started.html).

conftest.py

@@ -27,7 +27,6 @@
 import json
 import os
 import inspect
-import shutil
 import pytest
 import psutil
 import shutil
@@ -44,13 +43,15 @@
 from smartsim._core.config import CONFIG
 from smartsim.error import SSConfigError
 from subprocess import run
+import sys
 
 
 # Globals, yes, but its a testing file
 test_path = os.path.dirname(os.path.abspath(__file__))
 test_dir = os.path.join(test_path, "tests", "test_output")
 test_launcher = CONFIG.test_launcher
 test_device = CONFIG.test_device
+test_num_gpus = CONFIG.test_num_gpus
 test_nic = CONFIG.test_interface
 test_alloc_specs_path = os.getenv("SMARTSIM_TEST_ALLOC_SPEC_SHEET_PATH", None)
 test_port = CONFIG.test_port
@@ -73,6 +74,7 @@ def print_test_configuration():
     global test_nic
     global test_alloc_specs_path
     global test_port
+
     print("TEST_SMARTSIM_LOCATION:", smartsim.__path__)
     print("TEST_PATH:", test_path)
     print("TEST_LAUNCHER:", test_launcher)
@@ -511,7 +513,7 @@ def _test_dir_path(caller_function, caller_fspath):
         return dir_path
 
     @staticmethod
-    def get_test_dir(caller_function=None, caller_fspath=None):
+    def get_test_dir(caller_function=None, caller_fspath=None, level=1):
         """Get path to test output.
 
         This function should be called without arguments from within
@@ -530,7 +532,7 @@ def get_test_dir(caller_function=None, caller_fspath=None):
         :rtype: str
         """
         if not caller_function or not caller_fspath:
-            caller_frame = inspect.stack()[1]
+            caller_frame = inspect.stack()[level]
             caller_fspath = caller_frame.filename
             caller_function = caller_frame.function
 
@@ -541,7 +543,7 @@ def get_test_dir(caller_function=None, caller_fspath=None):
         return dir_path
 
     @staticmethod
-    def make_test_dir(caller_function=None, caller_fspath=None):
+    def make_test_dir(caller_function=None, caller_fspath=None, level=1):
         """Create test output directory and return path to it.
 
         This function should be called without arguments from within
@@ -558,7 +560,7 @@ def make_test_dir(caller_function=None, caller_fspath=None):
         :rtype: str
         """
         if not caller_function or not caller_fspath:
-            caller_frame = inspect.stack()[1]
+            caller_frame = inspect.stack()[level]
             caller_fspath = caller_frame.filename
             caller_function = caller_frame.function
 
@@ -591,3 +593,38 @@ class MLUtils:
     def get_test_device():
         global test_device
         return test_device
+
+    @staticmethod
+    def get_test_num_gpus():
+        return test_num_gpus
+
+@pytest.fixture
+def coloutils():
+    return ColoUtils
+
+class ColoUtils:
+    def setup_test_colo(fileutils, db_type, exp, db_args):
+        """Setup things needed for setting up the colo pinning tests"""
+        # get test setup
+        test_dir = fileutils.make_test_dir(level=2)
+        sr_test_script = fileutils.get_test_conf_path("send_data_local_smartredis.py")
+
+        # Create an app with a colo_db which uses 1 db_cpu
+        colo_settings = exp.create_run_settings(exe=sys.executable, exe_args=sr_test_script)
+        colo_model = exp.create_model(f"colocated_model", colo_settings)
+        colo_model.set_path(test_dir)
+
+        if db_type in ['tcp', "deprecated"]:
+            db_args["port"] = 6780
+            db_args["ifname"] = "lo"
+
+        colocate_fun = {
+            "tcp": colo_model.colocate_db_tcp,
+            "deprecated": colo_model.colocate_db,
+            "uds":colo_model.colocate_db_uds
+        }
+        colocate_fun[db_type](**db_args)
+        # assert model will launch with colocated db
+        assert colo_model.colocated
+        # Check to make sure that limit_db_cpus made it into the colo settings
+        return colo_model

doc/_static/version_names.json

@@ -1,14 +1,16 @@
 {
     "version_names":[
         "develop (unstable)",
-        "0.4.2 (stable)",
+        "0.5.0 (stable)",
+        "0.4.2",
         "0.4.1",
         "0.4.0",
         "0.3.2"
     ],
     "version_urls": [
         "https://www.craylabs.org/develop/overview.html",
         "https://www.craylabs.org/docs/overview.html",
+        "https://www.craylabs.org/docs/versions/0.4.2/overview.html",
         "https://www.craylabs.org/docs/versions/0.4.1/overview.html",
         "https://www.craylabs.org/docs/versions/0.4.0/overview.html",
         "https://www.craylabs.org/docs/versions/0.3.2/overview.html"