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

Example in main page does not mention data folder structure #29

Open
albarji opened this issue Oct 15, 2023 · 0 comments
Open

Example in main page does not mention data folder structure #29

albarji opened this issue Oct 15, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@albarji
Copy link
Member

albarji commented Oct 15, 2023

The example in the Quick Tour section of the README file goes as follows:

from aisee import Trainer, VisionClassifier

# Initialize a VisionClassifier model
model = VisionClassifier(
    model_name="vgg11_bn", 
    num_classes=4,
)

# Create a Trainer 
trainer = Trainer(
    base_model=model, 
    data=f"animals/",
    output_dir="trained_weights.pt",
)

# Train
trainer.train()

However, this example assumes that the data folder animals/ contains a subfolder named train with the training data, and another folder val with the validation data. This requirement is correctly documented in the Trainer API, but I believe it should also be stated in the README for clarity.

@albarji albarji added the documentation Improvements or additions to documentation label Oct 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant