mlpack / mlpack/models

Finish transition to models/examples repository

Open
#1 7 comments 7 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

s: keep open
Dominant language
C++
Stars
44
Forks
40
PR merge metrics
No merged PRs in 30d

Description

I just wanted to create an issue to point out that there are some cleanup bits that need to be done in this repository after the changes we decided to make to the repository structure in mlpack/examples#61.

This is the "models" repository, which will contain ready-to-use implementations of popular machine learning model types that aren't available in the normal mlpack codebase. These can be used as bindings.

So, here's a basic todo:

  • update README
  • set up mlpack-bot
  • set up labels
  • remove any "simple" examples and replace with bindings that have CLI support, etc.
  • set up CMake configuration so that the models can be compiled. Maybe that means using git submodules and the mlpack repository's CMake configuration?
  • update any references to the models/ repository
  • update the website to point to this repository

Contributor guide

Open the contributing guide

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 by reviewing the repository-structure changes referenced in mlpack/examples#61 and the remaining unchecked items in this issue. Determine the scope of each task, including model replacements, CMake setup, reference updates, and website changes. Done means all remaining checklist items are completed and the repository transition is finished.

Written by the indexing model from the issue text.

Assessment

Tech stack
cmake, cpp, git
Domain
build-system, documentation, machine-learning
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.