Documentation Updated: Installation, landing page and resources #429
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mairooni
requested changes
May 20, 2024
docs/source/installation.rst
Outdated
|
|
||
| A) Automatic Installation | ||
| =========================== | ||
| Installer Script |
There was a problem hiding this comment.
Suggestion: Installer Script -> Installation Script
docs/source/installation.rst
Outdated
|
|
||
|
|
||
| .. _installation_windows: | ||
|
|
||
| Installing TornadoVM for Windows 10/11 | ||
| Installattion for Windows 10/11 |
There was a problem hiding this comment.
Installattion -> Installation
docs/source/installation.rst
Outdated
|
|
||
| A) Using the automatic installation script. This script downloads the following dependencies: | ||
| The installer script downloads the following dependencies: |
There was a problem hiding this comment.
If you implement the suggestion above, change this to the "installation script"
|
|
||
| The ``tornadovm-installer`` script provided in this repository will compile/download OpenJDK, CMake, Maven and it will build TornadoVM. | ||
| The ``tornadovm-installer`` script provided in this repository will compile/download ``OpenJDK``, ``CMake``, ``Maven`` and it will build the TornadoVM project. | ||
| This installation script has been tested on Linux, macOS and Windows. |
There was a problem hiding this comment.
If you don't apply the suggestion, consider changing the "installation script" to "installer script" for consistency.
docs/source/installation.rst
Outdated
| In this case, you need to install all dependencies (Java, maven and cmake) before building the project. | ||
| Once all dependencies are provided, execute the following commands: | ||
|
|
||
| And TornadoVM is readyt to be used. If you want to recompile with a different backend: |
docs/source/installation.rst
Outdated
| @@ -662,7 +375,7 @@ Once all dependencies are provided, execute the following commands: | |||
|
|
|||
| .. _installation_mali: | |||
|
|
|||
| TornadoVM on ARM Mali GPUs | |||
| Installattion for ARM Mali GPUs | |||
There was a problem hiding this comment.
Installattion -> Installation
mairooni
approved these changes
May 20, 2024
stratika
requested changes
May 22, 2024
docs/source/resources.rst
Outdated
Comment on lines
43
to
45
| - Adam Bien Podcast with Juan Fumero: `TornadoVM, Paravox.ai: Java, AI, LLMs and Hardware Acceleration <https://airhacks.fm/#episode_282>`_. | ||
|
|
||
| - Adam Bien Podcast with Juan Fumero: `FPGAs, GPUs or Data Science with Java <https://airhacks.fm/#episode_282>`_. |
There was a problem hiding this comment.
The links are the same on those two podcasts.
Co-authored-by: Thanos Stratikopoulos <34061419+stratika@users.noreply.github.com>
stratika
approved these changes
May 22, 2024
jjfumero
added a commit
to jjfumero/TornadoVM
that referenced
this pull request
May 28, 2024
Improvements ~~~~~~~~~~~~~~~~~~ - beehive-lab#402 <beehive-lab#402>: Support for TornadoNativeArrays from FFI buffers. - beehive-lab#403 <beehive-lab#403>: Clean-up and refactoring for the code analysis of the loop-interchange. - beehive-lab#405 <beehive-lab#405>: Disable Loop-Interchange for CPU offloading.. - beehive-lab#407 <beehive-lab#407>: Debugging OpenCL Kernels builds improved. - beehive-lab#410 <beehive-lab#410>: CPU block scheduler disabled by default and option to switch between different thread-schedulers added. - beehive-lab#418 <beehive-lab#418>: TornadoOptions and TornadoLogger improved. - beehive-lab#423 <beehive-lab#423>: MxM using ns instead of ms to report performance. - beehive-lab#425 <beehive-lab#425>: Vector types for ``Float<Width>`` and ``Int<Width>`` supported. - beehive-lab#429 <beehive-lab#429>: Documentation of the installation process updated and improved. - beehive-lab#432 <beehive-lab#432>: Support for SPIR-V code generation and dispatcher using the TornadoVM OpenCL runtime. Compatibility ~~~~~~~~~~~~~~~~~~ - beehive-lab#409 <beehive-lab#409>: Guidelines to build the documentation. - beehive-lab#411 <beehive-lab#411>: Windows installer improved. - beehive-lab#412 <beehive-lab#412>: Python installer improved to check download all Python dependencies before the main installer. - beehive-lab#413 <beehive-lab#413>: Improved documentation for installing all configurations of backends and OS. - beehive-lab#424 <beehive-lab#424>: Use Generic GPU Scheduler for some older NVIDIA Drivers for the OpenCL runtime. - beehive-lab#430 <beehive-lab#430>: Improved the installer by checking that the TornadoVM environment is loaded upfront. Bug Fixes ~~~~~~~~~~~~~~~~~~ - beehive-lab#400 <beehive-lab#400>: Fix batch computation when the global thread indexes are used to compute the outputs. - beehive-lab#414 <beehive-lab#414>: Recover Test-Field unit-tests using Panama types. - beehive-lab#415 <beehive-lab#415>: Check style errors fixed. - beehive-lab#416 <beehive-lab#416>: FPGA execution with multiple tasks in a task-graph fixed. - beehive-lab#417 <beehive-lab#417>: Lazy-copy out fixed for Java fields. - beehive-lab#420 <beehive-lab#420>: Fix Mandelbrot example. - beehive-lab#421 <beehive-lab#421>: OpenCL 2D thread-scheduler fixed for NVIDIA GPUs. - beehive-lab#422 <beehive-lab#422>: Compilation for NVIDIA Jetson Nano fixed. - beehive-lab#426 <beehive-lab#426>: Fix Logger for all backends. - beehive-lab#428 <beehive-lab#428>: Math cos/sin operations supported for vector types. - beehive-lab#431 <beehive-lab#431>: Jenkins files fixed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR updates the documentation with special attention to the installation steps for all supported OS.
Problem description
n/ a.
Backend/s tested
Mark the backends affected by this PR.
OS tested
Mark the OS where this PR is tested.
Did you check on FPGAs?
If it is applicable, check your changes on FPGAs.
How to test the new patch?