Browse Source

refactor contributing and pull request template

Igor Kasianenko 2 months ago
parent
commit
738413870e
3 changed files with 11 additions and 11 deletions
  1. 1 1
      .github/PULL_REQUEST_TEMPLATE.md
  2. 6 6
      CONTRIBUTING.md
  3. 4 4
      pyproject.toml

+ 1 - 1
.github/PULL_REQUEST_TEMPLATE.md

@@ -28,7 +28,7 @@ Logs for Test B
 
 ## Before submitting
 - [ ] This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
-- [ ] Did you read the [contributor guideline](https://github.com/facebookresearch/llama-recipes/blob/main/CONTRIBUTING.md#pull-requests),
+- [ ] Did you read the [contributor guideline](https://github.com/meta-llama/llama-cookbook/blob/main/CONTRIBUTING.md),
       Pull Request section?
 - [ ] Was this discussed/approved via a Github issue? Please add a link
       to it if that's the case.

+ 6 - 6
CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# Contributing to llama-recipes
+# Contributing to llama-cookbook
 We want to make contributing to this project as easy and transparent as
 possible.
 
@@ -27,18 +27,18 @@ disclosure of security bugs. In those cases, please go through the process
 outlined on that page and do not file a public issue.
 
 ## License
-By contributing to llama-recipes, you agree that your contributions will be licensed
+By contributing to llama-cookbook, you agree that your contributions will be licensed
 under the LICENSE file in the root directory of this source tree.
 
 ## Tests
-Llama-recipes currently comes with a basic set of unit tests (covering the parts of the main training script and training loop) but we strive to increase our test coverage in the future in order to mitigate silent errors.
+Llama-cookbook currently comes with a basic set of unit tests (covering the parts of the main training script and training loop) but we strive to increase our test coverage in the future in order to mitigate silent errors.
 When submitting a new feature PR please make sure to cover the newly added code with a unit test.
 Run the tests locally to ensure the new feature does not break an old one.
-We use **pytest** for our unit tests and to run them locally you need to install llama-recipes with optional [tests] dependencies enabled:
+We use **pytest** for our unit tests and to run them locally you need to install llama-cookbook with optional [tests] dependencies enabled:
 ```
-pip install --extra-index-url https://download.pytorch.org/whl/test/cu118 llama-recipes[tests]
+pip install --extra-index-url https://download.pytorch.org/whl/test/cu118 llama-cookbook[tests]
 ```
-For development and contributing to llama-recipes please install from source with all optional dependencies:
+For development and contributing to llama-cookbook please install from source with all optional dependencies:
 ```
 pip install -U pip setuptools
 pip install --extra-index-url https://download.pytorch.org/whl/test/cu118 -e .[tests,auditnlg,vllm]

+ 4 - 4
pyproject.toml

@@ -3,14 +3,14 @@ requires = ["hatchling", "hatch-requirements-txt"]
 build-backend = "hatchling.build"
 
 [project]
-name = "llama-recipes"
+name = "llama-cookbook"
 version = "0.0.4.post1"
 authors = [
   { name="Hamid Shojanazeri", email="hamidnazeri@meta.com" },
   { name="Matthias Reso", email="mreso@meta.com" },
   { name="Geeta Chauhan", email="gchauhan@meta.com" },
 ]
-description = "Llama-recipes is a companion project to the Llama models. It's goal is to provide examples to quickly get started with fine-tuning for domain adaptation and how to run inference for the fine-tuned models."
+description = "Llama-cookbook is a companion project to the Llama models. It's goal is to provide examples to quickly get started with fine-tuning for domain adaptation and how to run inference for the fine-tuned models."
 readme = "README.md"
 requires-python = ">=3.8"
 classifiers = [
@@ -27,8 +27,8 @@ auditnlg = ["auditnlg"]
 langchain = ["langchain_openai", "langchain", "langchain_community"]
 
 [project.urls]
-"Homepage" = "https://github.com/facebookresearch/llama-recipes/"
-"Bug Tracker" = "https://github.com/facebookresearch/llama-recipes/issues"
+"Homepage" = "https://github.com/meta-llama/llama-cookbook"
+"Bug Tracker" = "https://github.com/meta-llama/llama-cookbook/issues"
 
 [tool.hatch.build]
 exclude = [