Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated readme descriptions and links #52

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Conversation

jennamk14
Copy link
Collaborator

Updated descriptions of links to include which ones redirect to HF
Updated links to scripts within the repo

@jennamk14 jennamk14 requested a review from egrace479 October 8, 2024 21:16
@jennamk14 jennamk14 self-assigned this Oct 8, 2024
@jennamk14
Copy link
Collaborator Author

@egrace479 question on readme - when referencing terminal commands to run the scripts, for example line 79 detector2cvat --video path_to_videos --save path_to_save does the detector2cvat need to have a .py at the end? or is this not needed for scripts part of the pyproject? thanks!

Copy link
Member

@egrace479 egrace479 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few small changes.

As to your question @jennamk14, as a package it is a command that can be run now (so no .py, that would be executing the file).

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved


To use the [KABR model](https://huggingface.co/imageomics/x3d-kabr-kinetics), download `checkpoint_epoch_00075.pyth.zip`, unzip `checkpoint_epoch_00075.pyth`, and install [SlowFast](https://github.com/facebookresearch/SlowFast). Then run [miniscene2behavior.py](miniscene2behavior.py).
To use the [KABR model](https://huggingface.co/imageomics/x3d-kabr-kinetics), download `checkpoint_epoch_00075.pyth.zip`, unzip `checkpoint_epoch_00075.pyth` from HuggingFace, and install [SlowFast](https://github.com/facebookresearch/SlowFast). Then run [miniscene2behavior.py](miniscene2behavior.py).
Copy link
Member

@egrace479 egrace479 Oct 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To use the [KABR model](https://huggingface.co/imageomics/x3d-kabr-kinetics), download `checkpoint_epoch_00075.pyth.zip`, unzip `checkpoint_epoch_00075.pyth` from HuggingFace, and install [SlowFast](https://github.com/facebookresearch/SlowFast). Then run [miniscene2behavior.py](miniscene2behavior.py).
To use the [KABR model](https://huggingface.co/imageomics/x3d-kabr-kinetics), download `checkpoint_epoch_00075.pyth.zip` from Hugging Face, unzip `checkpoint_epoch_00075.pyth`, and install [SlowFast](https://github.com/facebookresearch/SlowFast). Then run [miniscene2behavior.py](miniscene2behavior.py).

Though I think we're going to integrate a more direct call from HF?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jennamk14, I think this would be the only edit needed here.

jennamk14 and others added 3 commits October 18, 2024 10:23
Co-authored-by: Elizabeth Campolongo <[email protected]>
Co-authored-by: Elizabeth Campolongo <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants