kubeedge/ianvs

Inconsistent with interface name 'initial_model_url' and environment variable 'base_model_url'

Open

#14 opened on Aug 9, 2022

View on GitHubContributor guide
 (5 comments) (0 reactions) (1 assignee)Python (168 forks)auto 404
good first issuekind/cleanup

Repository metrics

Stars
 (178 stars)
PR merge metrics
 (PR metrics pending)

Description

What would you like to be added/modified: While configuring algorithm.yaml, the pre-trained model url is specified as initial_model_url, however in test_algorithms/basemodel.py it is parsed and renamed as base_model_url.

Why is this needed: This inconsistency might be confusing for algorithm developers. May I possibly recommend revising these two names to the same one rather than keeping this inconsistency.

Contributor guide

Research direction
Search the repository for all occurrences of `initial model url` and `base model url`. Determine which name is preferred by the project, then update the code, tests, and documentation accordingly. Check the `algorithm.yaml` configuration and `test algorithms/basemodel.py` for context.
Tech stack
python
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80