Add a symlink for llama_models (#201)

* Add a symlink for llama_models

* Update README.md paths

Author: ashwinb

README.md

@@ -53,15 +53,15 @@ You need to install the following dependencies (in addition to the `requirements
 pip install torch fairscale fire blobfile
 ```
 
-After installing the dependencies, you can run the example scripts (within `models/scripts/` sub-directory) as follows:
+After installing the dependencies, you can run the example scripts (within `llama_models/scripts/` sub-directory) as follows:
 ```bash
 #!/bin/bash
 
 CHECKPOINT_DIR=~/.llama/checkpoints/Meta-Llama3.1-8B-Instruct
-PYTHONPATH=$(git rev-parse --show-toplevel) torchrun models/scripts/example_chat_completion.py $CHECKPOINT_DIR
+PYTHONPATH=$(git rev-parse --show-toplevel) torchrun llama_models/scripts/example_chat_completion.py $CHECKPOINT_DIR
 ```
 
-The above script should be used with an Instruct (Chat) model. For a Base model, use the script `models/scripts/example_text_completion.py`. Note that you can use these scripts with both Llama3 and Llama3.1 series of models.
+The above script should be used with an Instruct (Chat) model. For a Base model, use the script `llama_models/scripts/example_text_completion.py`. Note that you can use these scripts with both Llama3 and Llama3.1 series of models.
 
 For running larger models with tensor parallelism, you should modify as:
 ```bash
@@ -70,7 +70,7 @@ For running larger models with tensor parallelism, you should modify as:
 NGPUS=8
 PYTHONPATH=$(git rev-parse --show-toplevel) torchrun \
   --nproc_per_node=$NGPUS \
-  models/scripts/example_chat_completion.py $CHECKPOINT_DIR \
+  llama_models/scripts/example_chat_completion.py $CHECKPOINT_DIR \
   --model_parallel_size $NGPUS
 ```
 

llama_models

@@ -0,0 +1 @@
+models

models/scripts/example_chat_completion.py

@@ -12,14 +12,14 @@
 
 import fire
 
-from models.llama3.api.datatypes import (
+from llama_models.llama3.api.datatypes import (
     CompletionMessage,
     StopReason,
     SystemMessage,
     UserMessage,
 )
 
-from models.llama3.reference_impl.generation import Llama
+from llama_models.llama3.reference_impl.generation import Llama
 
 
 def run_main(

models/scripts/example_text_completion.py

@@ -11,9 +11,9 @@
 from typing import Optional
 
 import fire
-from termcolor import cprint
 
-from models.llama3.reference_impl.generation import Llama
+from llama_models.llama3.reference_impl.generation import Llama
+from termcolor import cprint
 
 
 def run_main(

models/scripts/multimodal_example_chat_completion.py

@@ -12,11 +12,11 @@
 
 import fire
 
-from PIL import Image as PIL_Image
+from llama_models.llama3.api.datatypes import ImageMedia, UserMessage
 
-from models.llama3.api.datatypes import ImageMedia, UserMessage
+from llama_models.llama3.reference_impl.generation import Llama
 
-from models.llama3.reference_impl.generation import Llama
+from PIL import Image as PIL_Image
 
 
 def run_main(

models/scripts/multimodal_example_text_completion.py

@@ -12,12 +12,12 @@
 
 import fire
 
-from PIL import Image as PIL_Image
-from termcolor import cprint
+from llama_models.llama3.api.datatypes import ImageMedia
 
-from models.llama3.api.datatypes import ImageMedia
+from llama_models.llama3.reference_impl.generation import Llama
 
-from models.llama3.reference_impl.generation import Llama
+from PIL import Image as PIL_Image
+from termcolor import cprint
 
 
 def run_main(

setup.py

@@ -37,7 +37,7 @@ def read_requirements():
     long_description=open("README.md").read(),
     long_description_content_type="text/markdown",
     url="https://github.com/meta-llama/llama-models",
-    package_dir={"llama_models": "models"},
+    package_dir={"llama_models": "llama_models"},
     classifiers=[],
     python_requires=">=3.10",
     install_requires=read_requirements(),