Userspace Resource Manager (URM)

Official repo of URM project. Includes:

• resource-tuner
• contextual-classifier

Branches

main: Primary development branch. Contributors should develop submissions based on this branch, and submit pull requests to this branch.

gh-pages: Used for hosting and deploying doxygen generated source documentation

Requirements

This project depends on the following external libraries:

• libyaml – Used for parsing and handling YAML configuration files.
• libsystemd - Used for communication over dbus (optional)
• Installing Dependencies:
  • Yocto: Add the following to your recipe or image

    DEPENDS += "libyaml systemd"

  • Ubuntu:

    apt-get install -y libyaml-dev
    apt-get install -y libsystemd-dev
    apt install fasttext
    apt install libfasttext-dev

Build and install Instructions

• Create a build directory

mkdir -p build && cd build

• Configure the project: Default Build

cmake .. -DCMAKE_INSTALL_PREFIX=/

With classifier support enabled:

cmake .. -DCMAKE_INSTALL_PREFIX=/ -DBUILD_CLASSIFIER=ON

• Build the project

cmake  --build .

• Install to default directory (/usr/local)

sudo cmake --install .

• Start the URM Server

/usr/bin/urm

• Install to a custom temporary directory [Optional]

cmake --install . --prefix /tmp/urm-install

Documentation

Refer: https://qualcomm.github.io/userspace-resource-manager/

Development

How to develop new features/fixes for the software. Maybe different than "usage". Also provide details on how to contribute via a CONTRIBUTING.md file.

Getting in Contact

How to contact maintainers. E.g. GitHub Issues, GitHub Discussions could be indicated for many cases. However a mail list or list of Maintainer e-mails could be shared for other types of discussions. E.g.

• Report an Issue on GitHub
• Open a Discussion on GitHub
• E-mail us for general questions

License

userspace-resource-moderator is licensed under the BSD-3-Clause-Clear license. See LICENSE.txt for the full license text.