File size: 1,354 Bytes
3db4bdd
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
:github_url: https://github.com/AI4Finance-Foundation/FinRL

Installation
============

Using pip:
----------

If you do not need to finetune the models, you can install the package without the finetune dependency:

.. code:: bash

    pip install -U FlagEmbedding

If you want to finetune the models, you can install the package with the finetune dependency:

.. code:: bash

    pip install -U FlagEmbedding[finetune]


Install from sources:
---------------------

Clone the repository and install

.. code:: bash

    git clone https://github.com/FlagOpen/FlagEmbedding.git
    cd FlagEmbedding
    # If you do not need to finetune the models, you can install the package without the finetune dependency:
    pip install  .
    # If you want to finetune the models, install the package with the finetune dependency:
    pip install  .[finetune]

For development in editable mode:

.. code:: bash

    # If you do not need to finetune the models, you can install the package without the finetune dependency:
    pip install -e .
    # If you want to finetune the models, install the package with the finetune dependency:
    pip install -e .[finetune]

PyTorch-CUDA
------------

If you want to use CUDA GPUs during inference and finetuning, please install appropriate version of `PyTorch <https://pytorch.org/get-started/locally/>`_ with CUDA support.