Mention Java dependency in installation instructions
See original GitHub issue📚 The doc issue
torchserve
apparently requires Java (and, in particular, Java 17) in order to run. However, neither the README nor the Getting Started doc describe this requirement.
The closest I can find about this requirement are the Win Native and WSL docs. But anyone running on Linux would have no reason to read those docs. Furthermore, links to those Windows-related docs seem sparse.
Suggest a potential alternative/fix
Mention the need for Java to be installed, including the expected version of Java and setting the JAVA_HOME
environment variable, as part of the high level installation and getting started instructions.
Issue Analytics
- State:
- Created a year ago
- Comments:6 (4 by maintainers)
Top Results From Across the Web
Getting Started | Building Java Projects with Maven - Spring
First you'll need to setup a Java project for Maven to build. To keep the focus on Maven, make the project as simple...
Read more >Declaring Java dependencies using Maven - IBM
You declare dependencies in the Maven module's pom.xml file. The following instructions include snippets showing how to declare a dependency on each artifact....
Read more >How to manage Java dependencies with Maven - Red Hat
How to manage Java dependencies with Maven · [ Download A Java developer's guide to Quarkus. ] · [ Learn more about how...
Read more >Introduction to the Dependency Mechanism - Apache Maven
Dependency management is a core feature of Maven. Managing dependencies for a single project is easy. Managing dependencies for multi-module projects and ...
Read more >Maven dependencies | IntelliJ IDEA Documentation - JetBrains
IntelliJ IDEA lets you manage Maven dependencies in your project. You can add, import Maven dependencies, view them in the diagram, ...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
Thanks, @msaroufim Yes, I think the Java dependency is important enough to warrant mentioning up front in the README.
I suppose this is technically a separate issue, but the
ts_scripts/install_dependencies.py
does not appear to be a universal solution. For example, runningapt-get install -y openjdk-17-jdk
would not work for someone running on a RHEL-based distro.I generally refrain from running dependency installer scripts unless I’m 100% sure what it does. So I think it’d be good to document all the steps performed in the install_deps also in the README file.