OpenImagingLab / OpenImagingLab/FlashVSR

Additional documentation request

Open
#56 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1.9k
Forks
152
PR merge metrics
No merged PRs in 30d

Description

Several prereqs needed that were not in the readme. Requesting modifications to the documentation.
Additional steps I had to do to get this to compile on Windows 11.

  1. installed miniconda (curl https://repo.anaconda.com/miniconda/Miniconda3-latest-Windows-x86_64.exe -o .\miniconda.exe)
  2. install Microsoft build tools (don't install 2026) - https://visualstudio.microsoft.com/visual-cpp-build-tools/ msvc build tools (msvc v143 vs 2222 c++
  3. While installing Build tools select (windows 11 sdk 10.0.22621.0)
  4. reboot
  5. installed cuda toolkit 13.1 -- probably not needed
  6. installed cuda toolket 12.4
  7. reboot
  8. anaconda command prompt
  9. pip3 install torch==2.6.0 torchvision --index-url https://download.pytorch.org/whl/test/cu124
  10. pip3 install torch torchaudio --index-url https://download.pytorch.org/whl/cu124
  11. pip install modelscope

Note: although I'm an experienced dev. I have little experience in python. These steps are probably more familiar to CUDA and python devs, but to someone with little or outdated experience, this took some time to figure out.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the repository README and compare its installation prerequisites with the Windows 11 setup steps listed in this issue. Check which Miniconda, MSVC build tools, Windows SDK, PyTorch, and ModelScope requirements are still needed, then update the documentation so a Windows user can complete the setup and compilation without relying on undocumented steps.

Written by the indexing model from the issue text.

Assessment

Tech stack
anaconda, python, pytorch
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.