Update README.md
Browse files
    	
        README.md
    CHANGED
    
    | @@ -1,7 +1,10 @@ | |
| 1 | 
            -
            #  | 
| 2 | 
             
            The GeoEmbedding model is a geoscience-specific text embedding model built upon a high-performance large language model and fine-tuned on both general-purpose and in-domain geoscientific datasets. It produces accurate, context-aware vector representations of geoscientific texts, forming the backbone of vector-based retrieval in the RAG pipeline.
         | 
| 3 |  | 
| 4 | 
            -
             | 
|  | |
|  | |
|  | |
| 5 | 
             
            To load the GeoEmbedding model with Transformer, use the following snippet:
         | 
| 6 | 
             
            ```python
         | 
| 7 | 
             
            import numpy as np
         | 
| @@ -36,7 +39,7 @@ print(np.dot(q_vecs, p_vecs.T)) | |
| 36 | 
             
            ```
         | 
| 37 |  | 
| 38 | 
             
            ## License and Uses
         | 
| 39 | 
            -
            GeoEmbedding is liscensed under Apache License 2.0 | 
| 40 |  | 
| 41 | 
             
            The model is not intended for use in any manner that violates applicable laws or regulations, nor for any activities prohibited by the license agreement. Additionally, it should not be used in languages other than those explicitly supported, as outlined in this model card.
         | 
| 42 |  | 
|  | |
| 1 | 
            +
            # GeoEmbedding
         | 
| 2 | 
             
            The GeoEmbedding model is a geoscience-specific text embedding model built upon a high-performance large language model and fine-tuned on both general-purpose and in-domain geoscientific datasets. It produces accurate, context-aware vector representations of geoscientific texts, forming the backbone of vector-based retrieval in the RAG pipeline.
         | 
| 3 |  | 
| 4 | 
            +
            > 👉For full documentation, see: https://github.com/GeoGPT-Research-Project/GeoGPT-RAG
         | 
| 5 | 
            +
             | 
| 6 | 
            +
             | 
| 7 | 
            +
            ## Quickstart
         | 
| 8 | 
             
            To load the GeoEmbedding model with Transformer, use the following snippet:
         | 
| 9 | 
             
            ```python
         | 
| 10 | 
             
            import numpy as np
         | 
|  | |
| 39 | 
             
            ```
         | 
| 40 |  | 
| 41 | 
             
            ## License and Uses
         | 
| 42 | 
            +
            GeoEmbedding is liscensed under [Apache License 2.0](https://github.com/GeoGPT-Research-Project/GeoGPT-RAG/blob/master/Apache_LICENSE). GeoEmbedding is trained on the foundation of [Mistral-7B-Instruct-v0.1](https://huggingface.co/mistralai/Mistral-7B-Instruct-v0.1), which is also licensed under the [Apache License 2.0](https://huggingface.co/datasets/choosealicense/licenses/blob/main/markdown/apache-2.0.md). It is your responsibility to ensure that your use of GeoEmbedding adheres to the terms of both the GeoEmbedding model and its upstream dependency, [Mistral-7B-Instruct-v0.1](https://huggingface.co/mistralai/Mistral-7B-Instruct-v0.1).
         | 
| 43 |  | 
| 44 | 
             
            The model is not intended for use in any manner that violates applicable laws or regulations, nor for any activities prohibited by the license agreement. Additionally, it should not be used in languages other than those explicitly supported, as outlined in this model card.
         | 
| 45 |  | 
