Package: ml-git
⚠️ End-of-life notice.Effective immediately, HP has ended development, maintenance, and support of this project. The repo will be available in read-only mode until September 1st, 2024, when it will be deleted. You are welcome to create a copy and keep the project going.ML-GitML-Git is a tool which provides a Distributed Version Control system to enable efficient dataset management. Like its name emphasizes, it is inspired in git concepts and workflows, ML-Git enables the following operations:Manage a repository of different datasets, labels and models.Distribute these ML artifacts between members of a team or across organizations.Apply the right data governance and security models to their artifacts.If you are seeking to learn more about ML-Git, accessML-Git Page.How to installPrerequisites:GitPython 3.6.1+Pip 20.1.1+From repository:pip install ml-gitFrom source code:Download ML-Git from repository and execute commands below:cd ml-git/
pip install .How to uninstallpip uninstall ml-gitHow to configure1 - As ML-Git leverages git to manage ML entities metadata, it is necessary to configure user name and email address:git config --global user.name "Your User"
git config --global user.email "your_email@example.com"2 -OPTIONAL CONFIGURATIONS2.1 - Some ML-Git commands have a wizard to help you during their execution. Those commands have the--wizardoption available to enable this wizard. However, you can configure the wizard to be enabled by default on all supported commands by running the following command:ml-git repository config --set-wizard=enabled2.2 - You can also allow commands and options to be autocompleted with a[Tab]key press. For that, take a look at the following linkML-Git Shell Completion Support.3 - Storage:ML-Git needs a configured storage to store data from managed artifacts. Please take a look at theML-Git architecture and internals documentationto better understand how ML-Git works internally with data.To configure the storagesee documentation about supported storages and how to configure each one.4 - ML-Git project:An ML-Git project is an initialized directory that will contain a configuration file to be used by ML-Git in managing entities.
To configure it you can use the basic steps to configure the project described infirst project documentation.Usageml-git --help
Usage: ml-git [OPTIONS] COMMAND [ARGS]...

Options:
  --version  Show the version and exit.

Commands:
  clone       Clone an ml-git repository ML_GIT_REPOSITORY_URL
  datasets    Management of datasets within this ml-git repository.
  labels      Management of labels sets within this ml-git repository.
  models      Management of models within this ml-git repository.
  repository  Management of this ml-git repository.Basic commandsml-git clone <repository-url>ml-git clone https://github.com/user/ml_git_configuration_file_example.gitIf you prefer to create a new directory to clone into:ml-git clone https://github.com/user/ml_git_configuration_file_example.git my-project-dirIf you prefer keep git tracking files in the project:ml-git clone https://github.com/user/ml_git_configuration_file_example.git --trackml-git <ml-entity> createThis command will help you to start a new project, it creates your project artifact metadata:ml-git datasets create --categories="computer-vision, images" --bucket-name=your_bucket --import=../import-path --mutability=strict dataset-exDemonstration video:ml-git <ml-entity> statusShow changes in project workspace:ml-git datasets status dataset-exDemonstration video:ml-git <ml-entity> addAdd new files to index:ml-git datasets add dataset-exTo increment version:ml-git datasets add dataset-ex --bumpversionAdd an specific file:ml-git datasets add dataset-ex data/file_name.exDemonstration video:ml-git <ml-entity> commitConsolidate added files in the index to repository:ml-git datasets commit dataset-exDemonstration video:ml-git <ml-entity> pushUpload metadata to remote repository and send [chunks](docs/mlgit_internals.md) to storage:ml-git datasets push dataset-exDemonstration video:ml-git <ml-entity> checkoutChange workspace and metadata to versioned ml-entity tag:ml-git datasets checkout computer-vision__images__dataset-ex__1Demonstration video:More about commands in documentationHow to contributeYour contributions are always welcome!Fork the repository into your own GitHubClone the repository to your local machineCreate a new branch for your changes using the following pattern(feature | bugfix | hotfix)/branch_name. Example:feature/sftp_storage_implementationMake changes andtestPush the changes to your repositoryCreate a Pull Request from your forked repository to the ML-Git repository with comprehensive description of changesAnother way to contribute with the community is creating an issue to track your ideas, doubts, enhancements, tasks, or bugs found.
If an issue with the same topic already exists, discuss on the issue.LinksML-Git API documentation- Find the commands that are available in our api, usage examples and more.Working with tabular data- Find suggestions on how to use ml-git with tabular data.ml-git data specialization plugins- Dynamically link third-party packages to add specialized behaviors for the data type.