search

IBM / text-generation-inference

IBM development fork of https://github.com/huggingface/text-generation-inference
Apache License 2.0
57 stars 30 forks source link

chore: Make help #25

Closed ckadner closed 8 months ago

ckadner commented 9 months ago

Motivation

Make it easy to understand which Make targets there are and what they do.

Modifications

Result

$ make help
Usage:
  make <target>

Targets:
  build                 Build server release image
  help                  Display this help
  install               Install server, router, launcher, and custom kernels
  build-test-image      Build the test image.
  integration-tests     Run integration tests
  python-tests          Run Python tests

Related Issues

N/A

dtrifiro commented 9 months ago

Great addition. Another change that would be helpful is explicitly marking targets as PHONY, something like I've done in this branch (based on this PR).

Commit: https://github.com/dtrifiro/text-generation-inference/commit/79f2511f424568acb424e36f907796a8f90b2577

njhill commented 8 months ago

@ckadner want to pull in @dtrifiro's commit too before we merge this?

ckadner commented 8 months ago

@ckadner want to pull in @dtrifiro's commit too before we merge this?

I could. Wasn't sure if we wanted to hold off with making changes that would possibly complicate future syncs.

ckadner commented 8 months ago

@njhill -- I had merged the changes from @dtrifiro making him a co-author on this PR.

Did you want me to make further updates for this PR? There are more Make targets that could use a help text but I wanted to start with at least the main ones.

ckadner commented 8 months ago

@joerunde -- thanks for merging in the latest changes from main which triggered a build failure -- it revealed something I missed in PR #38 (and #43) -- to not log in to the image registries for forked PRs -- fixed now