{"id":17975964,"url":"https://github.com/getnamo/ml-remote-server","last_synced_at":"2025-05-13T04:33:24.240Z","repository":{"id":54283637,"uuid":"222237305","full_name":"getnamo/ml-remote-server","owner":"getnamo","description":"Server component of https://github.com/getnamo/machine-learning-remote-ue4","archived":false,"fork":false,"pushed_at":"2024-12-05T03:37:01.000Z","size":69,"stargazers_count":25,"open_issues_count":1,"forks_count":14,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-01T18:12:27.900Z","etag":null,"topics":["python","pytorch","tensorflow","unreal"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/getnamo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-11-17T11:26:38.000Z","updated_at":"2025-03-26T03:10:31.000Z","dependencies_parsed_at":"2023-01-21T20:40:44.272Z","dependency_job_id":"fbc6b39e-e66d-4b02-8af7-a947fe5ded9e","html_url":"https://github.com/getnamo/ml-remote-server","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getnamo%2Fml-remote-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getnamo%2Fml-remote-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getnamo%2Fml-remote-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getnamo%2Fml-remote-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/getnamo","download_url":"https://codeload.github.com/getnamo/ml-remote-server/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253877265,"owners_count":21977632,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["python","pytorch","tensorflow","unreal"],"created_at":"2024-10-29T17:21:24.735Z","updated_at":"2025-05-13T04:33:21.858Z","avatar_url":"https://github.com/getnamo.png","language":"Python","funding_links":[],"categories":["Streaming / Network :"],"sub_categories":["Videos"],"readme":"# ml-remote-server\nServer complement of https://github.com/getnamo/MachineLearningRemote-Unreal.\nStartup the server, point your ```MachineLearningRemote``` component to your server address with the script file name set in ```DefaultScript``` property and it will load on begin play.\n\n## Quick Setup\n\n1. Install [python 3](https://www.python.org/downloads/) on target machine recommended version for e.g. tensorflow: 3.7.\n\n*Option 1)Using Windows Local Server*\n\n2. Update requirements.txt with any dependencies you need, e.g. tensorflow==2.2\n3. Double click on ```InstallRequirements``` (you may need to run this command in admin)\n\n![](https://i.imgur.com/zUInHbV.png)\n\n4. *(Optional)* If you're not using the autolaunch option on MachineLearnineRemote: Double click ```StartupServer.bat``` \n\n*Option 2) Using Remote Server*\n\n2. Pick a folder, navigate to it\n3. ```git clone https://github.com/getnamo/ml-remote-server.git```\n4. Update requirements.txt with any dependencies you need, e.g. ```tensorflow==2.2```\n5. run ```pip install -r requirements.txt```. \n6. In terminal type ```python server.py``` to start the server\n\nServer is now ready to use. \n\n\n*Optional Client Steps*\n\n1. Connect your unreal instance via https://github.com/getnamo/MachineLearningRemote-Unreal\n2. Listen to log events via your browser by going to ```\u003cserver ip\u003e:8080``` or [```localhost:8080```](http://localhost:8080) in your browser. There are some debug commands like ```/r \u003cscript name\u003e``` to swap script and ```/i``` to send dummy inputs; see https://github.com/getnamo/ml-remote-server/blob/master/server.py#L117 for all supported commands.\n\n## How to use\n\n### Startup event flow\n\n*Begin Play -\u003e (if connect on beginplay) connect to backend -\u003e (if start script on connection) Default Script start*\n\nListen to the ```OnScriptStarted``` event to know it's safe to send inputs/start training.\n\n### API\n\nSee https://github.com/getnamo/MachineLearningRemote-Unreal as all interaction beyond debugging is handled by client.\n\nKeep in mind that you can end play, do some code changes, and begin playing again without rebooting your server; the default script will be reloaded. You can also use the debug browser with ```/r \u003cscript name\u003e``` or call ```StartScript``` from ```MachineLearningRemote``` component to live reload a script even during play.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetnamo%2Fml-remote-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgetnamo%2Fml-remote-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetnamo%2Fml-remote-server/lists"}