Skip to content

Feedback on README for first time user #39

@mt19991

Description

@mt19991

I am relatively new to AI development and was going through the README to get openCUA working on my windows laptop. Some steps I had to go through (after talking to chatgpt) which could be listed in the README.
(I am assuming more advanced developers know these items already)

  1. The instructions ask to install requirements.txt. However, this file is only availble after doing a git clone and it is in the model directory. Could update the README to make clear that the git repo should be cloned first and change the path on the requirements.txt to add model\

  2. When I ran the snapshot download, There were a lot of warnings about not having installed huggingface_hub[hf_xnet] . Seems to be a performance optimization, but this might be something we add in README to either advise users to do this before the snapshot load or make it part of the requirements (Unsure of the side effects if this is required).

  3. The weblink to the huggingface_inference.py is broken (led to a 404). The file is there , so this is not a blocker.

At this point I am working through version conflicts and other errors in running the huggingface_inference.py. once I have that working I will give that feedback.

If you would I rather generate a PR with suggested changes to README, do let me knoe.

Thanks for making this repo available.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions