|
--- |
|
tags: |
|
- sentence-transformers |
|
- sentence-similarity |
|
- feature-extraction |
|
- generated_from_trainer |
|
- dataset_size:1832 |
|
- loss:TripletLoss |
|
base_model: sentence-transformers/multi-qa-MiniLM-L6-cos-v1 |
|
widget: |
|
- source_sentence: How can you add stocks to an empty Watchlist? |
|
sentences: |
|
- 'The advanced real-time charts feature allows users to analyze stock prices in-depth |
|
with various chart types and tick data. To access the advanced charting tools, |
|
tap on the icon located in the right corner of the chart. The chart will open |
|
in portrait mode, and you can customize the view using the following features: |
|
|
|
|
|
- **Time Interval:** The default interval is 15 minutes, but users can select |
|
intervals ranging from 1 minute to 1 month. |
|
|
|
- **Chart Type:** Choose from candle, colored line, or other types to personalize |
|
the view. |
|
|
|
- **Study Tools:** Add studies like Simple Moving Averages (SMA) and Volume Weighted |
|
Average Price (VWAP) for better trading decisions. |
|
|
|
- **Buy/Sell Calls:** Users can directly initiate buy or sell calls from the chart, |
|
taking them to the ordering section. |
|
|
|
- **Native Phone Features:** Utilize features like pinch to zoom in/out and swipe |
|
left or right for navigation. |
|
|
|
- **Cross-Sectional Line:** A dynamic line that helps in understanding pricing, |
|
enabling users to view prices by moving the line over the chart. |
|
|
|
- **Drawing Tools:** Easily accessible tools like measure, fib retracements, lines, |
|
and channels for technical analysis. |
|
|
|
- **Marker:** View key information like open, high, low, close, and volume of |
|
a specific candle at a particular time. |
|
|
|
- **Horizontal View:** Option to view the chart horizontally for a better perspective. |
|
|
|
- **Full-Screen Mode:** Users can opt for a full-screen view for a more detailed |
|
analysis. |
|
|
|
|
|
These features provide users with comprehensive tools for advanced chart analysis |
|
and trading decisions.' |
|
- '### More>Message Hub |
|
|
|
|
|
**FAQ:** |
|
|
|
Where can I find the different message sections in this section? |
|
|
|
|
|
**Answer:** |
|
|
|
To access the various message sections, navigate to More and then click on Message |
|
Hub. This section contains all the different message sections available for you |
|
to view and interact with.' |
|
- 'Watchlists are a handy feature that allows you to save your preferred stocks |
|
for easier and faster trading or investment decisions. You can access the Watchlist |
|
by selecting it from the bottom tab on the app. |
|
|
|
|
|
When creating a new Watchlist, you can add up to 5 lists, each capable of holding |
|
50 stocks. To add stocks to an empty Watchlist, use the "Search & Add" button, |
|
which will guide you to search for the desired stock and add it to your list. |
|
|
|
|
|
Once you have stocks in your Watchlist, you can utilize the Searchbox in each |
|
individual Watchlist to easily find specific stocks by typing their initials. |
|
Additionally, the Searchbox is equipped with a FILTER feature that allows you |
|
to refine your search by choosing the Exchange or sorting the stocks alphabetically |
|
or by percentage change. |
|
|
|
|
|
To customize your Watchlist further, you can rearrange the order of stocks, rename |
|
the Watchlist, and delete unwanted stocks. Simply long-press on a stock to enter |
|
editing mode, where you can rename it, drag it to a new position on the list, |
|
or remove it by using the Trash icon. Remember to save your changes to keep your |
|
Watchlist organized. |
|
|
|
|
|
To switch between Watchlists, you can either press the individual button for each |
|
list or swipe left on the app. This way, you can manage multiple Watchlists with |
|
ease.' |
|
- source_sentence: How can a user change their PIN on the stock broking platform? |
|
sentences: |
|
- 'Once you have completed your onboarding, you will receive a Unique Client ID |
|
(trading code). The time it takes for you to start trading will depend on whether |
|
you are KYC verified or not. |
|
|
|
|
|
If you are KYC verified: |
|
|
|
- If your account status is "Yes," you will need to verify, download, print, sign, |
|
and courier the pre-filled forms sent to your registered email address. |
|
|
|
- Your account will be active within 7 working hours from the time we receive |
|
your documents. |
|
|
|
- If your account status is "No," you will follow the same process, and your account |
|
will be active within 7 working days from the time we receive your documents. |
|
|
|
|
|
You will receive important emails regarding your account: |
|
|
|
1. Pending Documents Email: This email will inform you of any required documents |
|
and the time it will take for you to start trading. |
|
|
|
2. Login Credential Email: You will receive your Client ID and a system-generated |
|
password to log in for the first time. |
|
|
|
3. Welcome Email: This email will contain essential information like your Client |
|
ID, relevant documents, and back office login details. |
|
|
|
|
|
If you don''t receive these emails, contact us at care@choiceindia.com or call |
|
us at (+91) 88-2424-2424 with the subject "activate your account."' |
|
- 'Preferences |
|
|
|
|
|
To access your Preferences in Choice and customize how you view and use key features, |
|
follow these steps: |
|
|
|
1. Open your account and tap on "More." |
|
|
|
2. Select "My Preferences." |
|
|
|
|
|
Dark Theme: |
|
|
|
Enjoy our sleek Dark Theme by selecting the very first option in the menu labeled |
|
"DARK THEME." To switch back to the default Light Theme, open the menu and select |
|
the Light Theme option. |
|
|
|
|
|
--- |
|
|
|
**Cleaned Answer:** |
|
|
|
In the Preferences section of Choice, you can adjust how you view and utilize |
|
key features. To do this, open your account and tap on "More," then select "My |
|
Preferences." Switch to the Dark Theme by choosing the first option labeled "DARK |
|
THEME" in the menu. To go back to the default Light Theme, open the menu and select |
|
the Light Theme option.' |
|
- 'Watchlists are a handy feature that allows you to save your preferred stocks |
|
for easier and faster trading or investment decisions. You can access the Watchlist |
|
by selecting it from the bottom tab on the app. |
|
|
|
|
|
When creating a new Watchlist, you can add up to 5 lists, each capable of holding |
|
50 stocks. To add stocks to an empty Watchlist, use the "Search & Add" button, |
|
which will guide you to search for the desired stock and add it to your list. |
|
|
|
|
|
Once you have stocks in your Watchlist, you can utilize the Searchbox in each |
|
individual Watchlist to easily find specific stocks by typing their initials. |
|
Additionally, the Searchbox is equipped with a FILTER feature that allows you |
|
to refine your search by choosing the Exchange or sorting the stocks alphabetically |
|
or by percentage change. |
|
|
|
|
|
To customize your Watchlist further, you can rearrange the order of stocks, rename |
|
the Watchlist, and delete unwanted stocks. Simply long-press on a stock to enter |
|
editing mode, where you can rename it, drag it to a new position on the list, |
|
or remove it by using the Trash icon. Remember to save your changes to keep your |
|
Watchlist organized. |
|
|
|
|
|
To switch between Watchlists, you can either press the individual button for each |
|
list or swipe left on the app. This way, you can manage multiple Watchlists with |
|
ease.' |
|
- source_sentence: What information does the Profit & Loss report on the platform |
|
display, and how can I customize it? |
|
sentences: |
|
- '### More>Message Hub |
|
|
|
|
|
**FAQ:** |
|
|
|
Where can I find the different message sections in this section? |
|
|
|
|
|
**Answer:** |
|
|
|
To access the various message sections, navigate to More and then click on Message |
|
Hub. This section contains all the different message sections available for you |
|
to view and interact with.' |
|
- '**Position Section:** |
|
|
|
|
|
Under the Positions Tab, you can view the current value and overall gain/loss |
|
of your positions, including Futures & Options and cash/equity orders executed |
|
on the same day. |
|
|
|
|
|
- **LIST:** This section displays your invested value compared to the current |
|
value, which changes with market movements. It also shows your overall profit/loss. |
|
You can easily see this information at a glance. |
|
|
|
|
|
- **SEARCH:** Here, you can search for specific trades you entered or exited. |
|
You can filter your trades based on options like ALL, INTRADAY, TODAY, POSITION, |
|
ALPHABETICALLY, P&L, P&L%, and Quantity. |
|
|
|
|
|
- **CONVERT POSITION:** You can switch your positions from Intraday to Delivery |
|
or vice versa by selecting the Convert Position option. |
|
|
|
|
|
- **SCRIP INFO:** Clicking here will take you to a page dedicated to the scrip. |
|
You can also initiate new trades from this section. |
|
|
|
|
|
- **DETAILS:** This shows trade details for a particular scrip. By clicking on |
|
the "VIEW TRADES" hyperlink, you can see all trades you''ve made for that scrip. |
|
|
|
|
|
- **BUY/SELL:** This option allows you to place orders to enter or exit trades. |
|
|
|
|
|
**Orders Section:** |
|
|
|
|
|
This section displays Intraday trades and delivery orders, categorized as PENDING, |
|
EXECUTED, TRADES, and OTHERS. |
|
|
|
|
|
1. **Pending:** Shows orders that were not executed, partially executed, or rejected. |
|
You can edit these orders by tapping on them. |
|
|
|
|
|
2. **Executed:** Lists all orders that were successfully executed, providing details |
|
such as INTRADAY, Last Traded Price (LTP), Market Closing Price, lots, and time. |
|
You can view trade details and history by clicking on the "VIEW TRADES" hyperlink. |
|
|
|
|
|
3. **Trades:** Displays the list of executed trades, especially for those trades |
|
that were completed in multiple steps. |
|
|
|
|
|
4. **Others:** Lists rejected trades along with reasons and additional details.' |
|
- '**Question:** |
|
|
|
How can I access detailed Reports of my trades and financial summaries on the |
|
platform? |
|
|
|
|
|
**Answer:** |
|
|
|
To access detailed Reports of your trades and financial summaries on the platform, |
|
you can go to the bottom tab and click on "More" followed by "Reports". There, |
|
you will find the following sections: |
|
|
|
|
|
**P&L Report:** |
|
|
|
The Profit & Loss report displays your net P&L for trades. By default, it shows |
|
all trades taken during the current accounting year along with expenses. The report |
|
includes Total Realized P&L and Total Unrealized P&L at the bottom strip. You |
|
can filter the report using Exchange, From Date, and To Date options. Additionally, |
|
you can search for specific details and download the report in PDF format or send |
|
it to your registered email. |
|
|
|
|
|
**Ledger:** |
|
|
|
The Ledger report resembles a typical account ledger, with Debit and Credit columns |
|
for the current FY year. Debit entries, representing sums owed, are displayed |
|
in red with negative values, while Credit entries, representing sums received, |
|
are shown in green with positive values. The report also shows the total closing |
|
balance at the bottom strip. Similar to the P&L report, you can filter, search, |
|
download in PDF format, and send this report via email. Moreover, you can access |
|
a detailed report by tapping on the top right corner for more actions such as |
|
sharing, saving, or emailing for future reference. |
|
|
|
|
|
**Back Office:** |
|
|
|
For more intricate and customized reports, a complete back-end panel named "Reports" |
|
is available. This panel allows you to view detailed reports and extract customized |
|
data as per your requirements. Login details for this panel are provided post-registration |
|
completion.' |
|
- source_sentence: How does the time to start trading vary based on whether a client |
|
is KYC verified or not? |
|
sentences: |
|
- 'Preferences |
|
|
|
|
|
To access your Preferences in Choice and customize how you view and use key features, |
|
follow these steps: |
|
|
|
1. Open your account and tap on "More." |
|
|
|
2. Select "My Preferences." |
|
|
|
|
|
Dark Theme: |
|
|
|
Enjoy our sleek Dark Theme by selecting the very first option in the menu labeled |
|
"DARK THEME." To switch back to the default Light Theme, open the menu and select |
|
the Light Theme option. |
|
|
|
|
|
--- |
|
|
|
**Cleaned Answer:** |
|
|
|
In the Preferences section of Choice, you can adjust how you view and utilize |
|
key features. To do this, open your account and tap on "More," then select "My |
|
Preferences." Switch to the Dark Theme by choosing the first option labeled "DARK |
|
THEME" in the menu. To go back to the default Light Theme, open the menu and select |
|
the Light Theme option.' |
|
- "Sign In Process:\n\n**First Time Login:**\n\n1. Enter your Client ID and the\ |
|
\ system-generated password provided.\n2. Create a new password that is alphanumeric\ |
|
\ (6-12 characters) with special characters.\n3. Confirm the new password.\n4.\ |
|
\ Set a new PIN (4-6 digits).\n5. Proceed to your account by clicking on the Next\ |
|
\ Button.\n\n**Existing User Login:**\n\n1. Enter your Client ID, Password, and\ |
|
\ PIN that you have set.\n2. \n\n**Activating Fingerprint/Face ID:**\n\n1. After\ |
|
\ entering Client ID and Password, enter the PIN.\n2. Choose to enable Fingerprint/Face\ |
|
\ ID authentication (available for certain devices).\n3. Next time, use Fingerprint/Face\ |
|
\ ID instead of the PIN to log in.\n\n**Forgot Password:**\n\n1. Click on 'Forgot\ |
|
\ Password' on the Login Page and provide Client ID or PAN.\n2. Receive a system-generated\ |
|
\ password on your registered Email or Mobile Number.\n3. Create a new password\ |
|
\ with special characters as instructed and confirm it.\n\n**Forgot PIN:**\n\n\ |
|
1. On the Login Page, click 'Forgot PIN' and receive a system-generated PIN.\n\ |
|
2. Create a new PIN and confirm it.\n\n**Changing Password:**\n\n1. Go to Menu\ |
|
\ > My Profile > Change Password.\n2. Enter Current Password, new password, and\ |
|
\ confirm.\n3. Click on Change Password.\n\n**Changing PIN:**\n\n1. Go to Menu\ |
|
\ > My Profile > Change PIN.\n2. Enter Current PIN, new PIN, and confirm.\n3.\ |
|
\ Click on Change PIN.\n\n**Account Locked Due to Incorrect Password:**\n\n1.\ |
|
\ If your account is locked, tap 'Forgot Password' and follow the instructions\ |
|
\ to unlock it." |
|
- 'Once you have completed your onboarding, you will receive a Unique Client ID |
|
(trading code). The time it takes for you to start trading will depend on whether |
|
you are KYC verified or not. |
|
|
|
|
|
If you are KYC verified: |
|
|
|
- If your account status is "Yes," you will need to verify, download, print, sign, |
|
and courier the pre-filled forms sent to your registered email address. |
|
|
|
- Your account will be active within 7 working hours from the time we receive |
|
your documents. |
|
|
|
- If your account status is "No," you will follow the same process, and your account |
|
will be active within 7 working days from the time we receive your documents. |
|
|
|
|
|
You will receive important emails regarding your account: |
|
|
|
1. Pending Documents Email: This email will inform you of any required documents |
|
and the time it will take for you to start trading. |
|
|
|
2. Login Credential Email: You will receive your Client ID and a system-generated |
|
password to log in for the first time. |
|
|
|
3. Welcome Email: This email will contain essential information like your Client |
|
ID, relevant documents, and back office login details. |
|
|
|
|
|
If you don''t receive these emails, contact us at care@choiceindia.com or call |
|
us at (+91) 88-2424-2424 with the subject "activate your account."' |
|
- source_sentence: How can I access and customize my Preferences in Choice? |
|
sentences: |
|
- 'Preferences |
|
|
|
|
|
To access your Preferences in Choice and customize how you view and use key features, |
|
follow these steps: |
|
|
|
1. Open your account and tap on "More." |
|
|
|
2. Select "My Preferences." |
|
|
|
|
|
Dark Theme: |
|
|
|
Enjoy our sleek Dark Theme by selecting the very first option in the menu labeled |
|
"DARK THEME." To switch back to the default Light Theme, open the menu and select |
|
the Light Theme option. |
|
|
|
|
|
--- |
|
|
|
**Cleaned Answer:** |
|
|
|
In the Preferences section of Choice, you can adjust how you view and utilize |
|
key features. To do this, open your account and tap on "More," then select "My |
|
Preferences." Switch to the Dark Theme by choosing the first option labeled "DARK |
|
THEME" in the menu. To go back to the default Light Theme, open the menu and select |
|
the Light Theme option.' |
|
- "To find a specific company or ETF on the Choice platform, you can follow these\ |
|
\ steps:\n\n1. Using Search:\n- Type the first three letters of the company's\ |
|
\ name (e.g., ICICI) to see a list of affiliated companies/ETFs on NSE/BSE. \n\ |
|
- Choose your segment (Equity, Derivatives, Commodities, or Currency).\n- Select\ |
|
\ the specific company from the results drop-down to view its overview.\n- Add\ |
|
\ the company to your WatchList or set a price alert.\n\n2. Scrip Page - Cash\ |
|
\ and F&O:\n- View detailed information about a company.\n- Search by typing the\ |
|
\ first 3 letters of the company name and selecting it for the overview.\n\n3.\ |
|
\ Overview Section:\n- Provides essential details like OPEN, HIGH, LOW, CLOSE.\n\ |
|
- Click (i) for more details like PRICE TICK, MARKET LOT, CIRCUIT RANGE, etc.\n\ |
|
- Market Depth shows BID and ASK numbers with quantities.\n\n4. Technical Section:\n\ |
|
- View Technical data and use the CHART tool for analysis.\n\n5. Pivot Points:\n\ |
|
- Shows RESISTANCE and SUPPORT levels.\n- Displays numbers for DAILY assessment\ |
|
\ by default, switch timeframes if needed.\n\n6. Futures Section:\n- Displays\ |
|
\ future prices for near term, mid term, and far term.\n\n7. Recent News:\n- Displays\ |
|
\ news related to the company from various sources.\n\n8. Scrip Page - Derivatives\ |
|
\ (F&O):\n- Search for company and view open Call/Put contracts.\n- Select a contract\ |
|
\ and view the Option Chain.\n- Buy/Sell contracts and execute orders.\n\nThese\ |
|
\ steps will help you navigate and use the features available on the Choice platform\ |
|
\ effectively." |
|
- "To find a specific company or ETF on the Choice platform, you can follow these\ |
|
\ steps:\n\n1. Using Search:\n- Type the first three letters of the company's\ |
|
\ name (e.g., ICICI) to see a list of affiliated companies/ETFs on NSE/BSE. \n\ |
|
- Choose your segment (Equity, Derivatives, Commodities, or Currency).\n- Select\ |
|
\ the specific company from the results drop-down to view its overview.\n- Add\ |
|
\ the company to your WatchList or set a price alert.\n\n2. Scrip Page - Cash\ |
|
\ and F&O:\n- View detailed information about a company.\n- Search by typing the\ |
|
\ first 3 letters of the company name and selecting it for the overview.\n\n3.\ |
|
\ Overview Section:\n- Provides essential details like OPEN, HIGH, LOW, CLOSE.\n\ |
|
- Click (i) for more details like PRICE TICK, MARKET LOT, CIRCUIT RANGE, etc.\n\ |
|
- Market Depth shows BID and ASK numbers with quantities.\n\n4. Technical Section:\n\ |
|
- View Technical data and use the CHART tool for analysis.\n\n5. Pivot Points:\n\ |
|
- Shows RESISTANCE and SUPPORT levels.\n- Displays numbers for DAILY assessment\ |
|
\ by default, switch timeframes if needed.\n\n6. Futures Section:\n- Displays\ |
|
\ future prices for near term, mid term, and far term.\n\n7. Recent News:\n- Displays\ |
|
\ news related to the company from various sources.\n\n8. Scrip Page - Derivatives\ |
|
\ (F&O):\n- Search for company and view open Call/Put contracts.\n- Select a contract\ |
|
\ and view the Option Chain.\n- Buy/Sell contracts and execute orders.\n\nThese\ |
|
\ steps will help you navigate and use the features available on the Choice platform\ |
|
\ effectively." |
|
pipeline_tag: sentence-similarity |
|
library_name: sentence-transformers |
|
--- |
|
|
|
# SentenceTransformer based on sentence-transformers/multi-qa-MiniLM-L6-cos-v1 |
|
|
|
This is a [sentence-transformers](https://www.SBERT.net) model finetuned from [sentence-transformers/multi-qa-MiniLM-L6-cos-v1](https://huggingface.co/sentence-transformers/multi-qa-MiniLM-L6-cos-v1). It maps sentences & paragraphs to a 384-dimensional dense vector space and can be used for semantic textual similarity, semantic search, paraphrase mining, text classification, clustering, and more. |
|
|
|
## Model Details |
|
|
|
### Model Description |
|
- **Model Type:** Sentence Transformer |
|
- **Base model:** [sentence-transformers/multi-qa-MiniLM-L6-cos-v1](https://huggingface.co/sentence-transformers/multi-qa-MiniLM-L6-cos-v1) <!-- at revision b207367332321f8e44f96e224ef15bc607f4dbf0 --> |
|
- **Maximum Sequence Length:** 512 tokens |
|
- **Output Dimensionality:** 384 tokens |
|
- **Similarity Function:** Cosine Similarity |
|
<!-- - **Training Dataset:** Unknown --> |
|
<!-- - **Language:** Unknown --> |
|
<!-- - **License:** Unknown --> |
|
|
|
### Model Sources |
|
|
|
- **Documentation:** [Sentence Transformers Documentation](https://sbert.net) |
|
- **Repository:** [Sentence Transformers on GitHub](https://github.com/UKPLab/sentence-transformers) |
|
- **Hugging Face:** [Sentence Transformers on Hugging Face](https://huggingface.co/models?library=sentence-transformers) |
|
|
|
### Full Model Architecture |
|
|
|
``` |
|
SentenceTransformer( |
|
(0): Transformer({'max_seq_length': 512, 'do_lower_case': False}) with Transformer model: BertModel |
|
(1): Pooling({'word_embedding_dimension': 384, 'pooling_mode_cls_token': False, 'pooling_mode_mean_tokens': True, 'pooling_mode_max_tokens': False, 'pooling_mode_mean_sqrt_len_tokens': False, 'pooling_mode_weightedmean_tokens': False, 'pooling_mode_lasttoken': False, 'include_prompt': True}) |
|
(2): Normalize() |
|
) |
|
``` |
|
|
|
## Usage |
|
|
|
### Direct Usage (Sentence Transformers) |
|
|
|
First install the Sentence Transformers library: |
|
|
|
```bash |
|
pip install -U sentence-transformers |
|
``` |
|
|
|
Then you can load this model and run inference. |
|
```python |
|
from sentence_transformers import SentenceTransformer |
|
|
|
# Download from the 🤗 Hub |
|
model = SentenceTransformer("Atharva26/sentence-transformer-finetuned-faq") |
|
# Run inference |
|
sentences = [ |
|
'How can I access and customize my Preferences in Choice?', |
|
'Preferences\n\nTo access your Preferences in Choice and customize how you view and use key features, follow these steps:\n1. Open your account and tap on "More."\n2. Select "My Preferences."\n\nDark Theme:\nEnjoy our sleek Dark Theme by selecting the very first option in the menu labeled "DARK THEME." To switch back to the default Light Theme, open the menu and select the Light Theme option.\n\n---\n**Cleaned Answer:**\nIn the Preferences section of Choice, you can adjust how you view and utilize key features. To do this, open your account and tap on "More," then select "My Preferences." Switch to the Dark Theme by choosing the first option labeled "DARK THEME" in the menu. To go back to the default Light Theme, open the menu and select the Light Theme option.', |
|
"To find a specific company or ETF on the Choice platform, you can follow these steps:\n\n1. Using Search:\n- Type the first three letters of the company's name (e.g., ICICI) to see a list of affiliated companies/ETFs on NSE/BSE. \n- Choose your segment (Equity, Derivatives, Commodities, or Currency).\n- Select the specific company from the results drop-down to view its overview.\n- Add the company to your WatchList or set a price alert.\n\n2. Scrip Page - Cash and F&O:\n- View detailed information about a company.\n- Search by typing the first 3 letters of the company name and selecting it for the overview.\n\n3. Overview Section:\n- Provides essential details like OPEN, HIGH, LOW, CLOSE.\n- Click (i) for more details like PRICE TICK, MARKET LOT, CIRCUIT RANGE, etc.\n- Market Depth shows BID and ASK numbers with quantities.\n\n4. Technical Section:\n- View Technical data and use the CHART tool for analysis.\n\n5. Pivot Points:\n- Shows RESISTANCE and SUPPORT levels.\n- Displays numbers for DAILY assessment by default, switch timeframes if needed.\n\n6. Futures Section:\n- Displays future prices for near term, mid term, and far term.\n\n7. Recent News:\n- Displays news related to the company from various sources.\n\n8. Scrip Page - Derivatives (F&O):\n- Search for company and view open Call/Put contracts.\n- Select a contract and view the Option Chain.\n- Buy/Sell contracts and execute orders.\n\nThese steps will help you navigate and use the features available on the Choice platform effectively.", |
|
] |
|
embeddings = model.encode(sentences) |
|
print(embeddings.shape) |
|
# [3, 384] |
|
|
|
# Get the similarity scores for the embeddings |
|
similarities = model.similarity(embeddings, embeddings) |
|
print(similarities.shape) |
|
# [3, 3] |
|
``` |
|
|
|
<!-- |
|
### Direct Usage (Transformers) |
|
|
|
<details><summary>Click to see the direct usage in Transformers</summary> |
|
|
|
</details> |
|
--> |
|
|
|
<!-- |
|
### Downstream Usage (Sentence Transformers) |
|
|
|
You can finetune this model on your own dataset. |
|
|
|
<details><summary>Click to expand</summary> |
|
|
|
</details> |
|
--> |
|
|
|
<!-- |
|
### Out-of-Scope Use |
|
|
|
*List how the model may foreseeably be misused and address what users ought not to do with the model.* |
|
--> |
|
|
|
<!-- |
|
## Bias, Risks and Limitations |
|
|
|
*What are the known or foreseeable issues stemming from this model? You could also flag here known failure cases or weaknesses of the model.* |
|
--> |
|
|
|
<!-- |
|
### Recommendations |
|
|
|
*What are recommendations with respect to the foreseeable issues? For example, filtering explicit content.* |
|
--> |
|
|
|
## Training Details |
|
|
|
### Training Hyperparameters |
|
#### Non-Default Hyperparameters |
|
|
|
- `eval_strategy`: steps |
|
- `per_device_train_batch_size`: 32 |
|
- `per_device_eval_batch_size`: 32 |
|
- `learning_rate`: 2e-05 |
|
- `num_train_epochs`: 2 |
|
- `lr_scheduler_type`: cosine |
|
- `warmup_ratio`: 0.3 |
|
|
|
#### All Hyperparameters |
|
<details><summary>Click to expand</summary> |
|
|
|
- `overwrite_output_dir`: False |
|
- `do_predict`: False |
|
- `eval_strategy`: steps |
|
- `prediction_loss_only`: True |
|
- `per_device_train_batch_size`: 32 |
|
- `per_device_eval_batch_size`: 32 |
|
- `per_gpu_train_batch_size`: None |
|
- `per_gpu_eval_batch_size`: None |
|
- `gradient_accumulation_steps`: 1 |
|
- `eval_accumulation_steps`: None |
|
- `torch_empty_cache_steps`: None |
|
- `learning_rate`: 2e-05 |
|
- `weight_decay`: 0.0 |
|
- `adam_beta1`: 0.9 |
|
- `adam_beta2`: 0.999 |
|
- `adam_epsilon`: 1e-08 |
|
- `max_grad_norm`: 1.0 |
|
- `num_train_epochs`: 2 |
|
- `max_steps`: -1 |
|
- `lr_scheduler_type`: cosine |
|
- `lr_scheduler_kwargs`: {} |
|
- `warmup_ratio`: 0.3 |
|
- `warmup_steps`: 0 |
|
- `log_level`: passive |
|
- `log_level_replica`: warning |
|
- `log_on_each_node`: True |
|
- `logging_nan_inf_filter`: True |
|
- `save_safetensors`: True |
|
- `save_on_each_node`: False |
|
- `save_only_model`: False |
|
- `restore_callback_states_from_checkpoint`: False |
|
- `no_cuda`: False |
|
- `use_cpu`: False |
|
- `use_mps_device`: False |
|
- `seed`: 42 |
|
- `data_seed`: None |
|
- `jit_mode_eval`: False |
|
- `use_ipex`: False |
|
- `bf16`: False |
|
- `fp16`: False |
|
- `fp16_opt_level`: O1 |
|
- `half_precision_backend`: auto |
|
- `bf16_full_eval`: False |
|
- `fp16_full_eval`: False |
|
- `tf32`: None |
|
- `local_rank`: 0 |
|
- `ddp_backend`: None |
|
- `tpu_num_cores`: None |
|
- `tpu_metrics_debug`: False |
|
- `debug`: [] |
|
- `dataloader_drop_last`: False |
|
- `dataloader_num_workers`: 0 |
|
- `dataloader_prefetch_factor`: None |
|
- `past_index`: -1 |
|
- `disable_tqdm`: False |
|
- `remove_unused_columns`: True |
|
- `label_names`: None |
|
- `load_best_model_at_end`: False |
|
- `ignore_data_skip`: False |
|
- `fsdp`: [] |
|
- `fsdp_min_num_params`: 0 |
|
- `fsdp_config`: {'min_num_params': 0, 'xla': False, 'xla_fsdp_v2': False, 'xla_fsdp_grad_ckpt': False} |
|
- `fsdp_transformer_layer_cls_to_wrap`: None |
|
- `accelerator_config`: {'split_batches': False, 'dispatch_batches': None, 'even_batches': True, 'use_seedable_sampler': True, 'non_blocking': False, 'gradient_accumulation_kwargs': None} |
|
- `deepspeed`: None |
|
- `label_smoothing_factor`: 0.0 |
|
- `optim`: adamw_torch |
|
- `optim_args`: None |
|
- `adafactor`: False |
|
- `group_by_length`: False |
|
- `length_column_name`: length |
|
- `ddp_find_unused_parameters`: None |
|
- `ddp_bucket_cap_mb`: None |
|
- `ddp_broadcast_buffers`: False |
|
- `dataloader_pin_memory`: True |
|
- `dataloader_persistent_workers`: False |
|
- `skip_memory_metrics`: True |
|
- `use_legacy_prediction_loop`: False |
|
- `push_to_hub`: False |
|
- `resume_from_checkpoint`: None |
|
- `hub_model_id`: None |
|
- `hub_strategy`: every_save |
|
- `hub_private_repo`: False |
|
- `hub_always_push`: False |
|
- `gradient_checkpointing`: False |
|
- `gradient_checkpointing_kwargs`: None |
|
- `include_inputs_for_metrics`: False |
|
- `eval_do_concat_batches`: True |
|
- `fp16_backend`: auto |
|
- `push_to_hub_model_id`: None |
|
- `push_to_hub_organization`: None |
|
- `mp_parameters`: |
|
- `auto_find_batch_size`: False |
|
- `full_determinism`: False |
|
- `torchdynamo`: None |
|
- `ray_scope`: last |
|
- `ddp_timeout`: 1800 |
|
- `torch_compile`: False |
|
- `torch_compile_backend`: None |
|
- `torch_compile_mode`: None |
|
- `dispatch_batches`: None |
|
- `split_batches`: None |
|
- `include_tokens_per_second`: False |
|
- `include_num_input_tokens_seen`: False |
|
- `neftune_noise_alpha`: None |
|
- `optim_target_modules`: None |
|
- `batch_eval_metrics`: False |
|
- `eval_on_start`: False |
|
- `use_liger_kernel`: False |
|
- `eval_use_gather_object`: False |
|
- `batch_sampler`: batch_sampler |
|
- `multi_dataset_batch_sampler`: proportional |
|
|
|
</details> |
|
|
|
### Training Logs |
|
| Epoch | Step | Training Loss | loss | |
|
|:------:|:----:|:-------------:|:------:| |
|
| 0.0345 | 2 | 4.7333 | - | |
|
| 0.0690 | 4 | 4.706 | - | |
|
| 0.1034 | 6 | 4.7013 | - | |
|
| 0.1379 | 8 | 4.721 | - | |
|
| 0.1724 | 10 | 4.6913 | - | |
|
| 0.2069 | 12 | 4.6712 | - | |
|
| 0.2414 | 14 | 4.6583 | - | |
|
| 0.2586 | 15 | - | 4.6563 | |
|
| 0.2759 | 16 | 4.6551 | - | |
|
| 0.3103 | 18 | 4.6552 | - | |
|
| 0.3448 | 20 | 4.6531 | - | |
|
| 0.3793 | 22 | 4.5423 | - | |
|
| 0.4138 | 24 | 4.5717 | - | |
|
| 0.4483 | 26 | 4.5314 | - | |
|
| 0.4828 | 28 | 4.5324 | - | |
|
| 0.5172 | 30 | 4.453 | 4.5032 | |
|
| 0.5517 | 32 | 4.5038 | - | |
|
| 0.5862 | 34 | 4.4599 | - | |
|
| 0.6207 | 36 | 4.3689 | - | |
|
| 0.6552 | 38 | 4.4138 | - | |
|
| 0.6897 | 40 | 4.3598 | - | |
|
| 0.7241 | 42 | 4.3962 | - | |
|
| 0.7586 | 44 | 4.2948 | - | |
|
| 0.7759 | 45 | - | 4.3505 | |
|
| 0.7931 | 46 | 4.3345 | - | |
|
| 0.8276 | 48 | 4.4072 | - | |
|
| 0.8621 | 50 | 4.2972 | - | |
|
| 0.8966 | 52 | 4.3006 | - | |
|
| 0.9310 | 54 | 4.3104 | - | |
|
| 0.9655 | 56 | 4.2059 | - | |
|
| 1.0 | 58 | 4.2059 | - | |
|
| 1.0345 | 60 | 4.2079 | 4.2349 | |
|
| 1.0690 | 62 | 4.23 | - | |
|
| 1.1034 | 64 | 4.2325 | - | |
|
| 1.1379 | 66 | 4.1432 | - | |
|
| 1.1724 | 68 | 4.235 | - | |
|
| 1.2069 | 70 | 4.1383 | - | |
|
| 1.2414 | 72 | 4.1703 | - | |
|
| 1.2759 | 74 | 4.1145 | - | |
|
| 1.2931 | 75 | - | 4.1638 | |
|
| 1.3103 | 76 | 4.0703 | - | |
|
| 1.3448 | 78 | 4.1306 | - | |
|
| 1.3793 | 80 | 4.0792 | - | |
|
| 1.4138 | 82 | 4.102 | - | |
|
| 1.4483 | 84 | 4.1091 | - | |
|
| 1.4828 | 86 | 4.1437 | - | |
|
| 1.5172 | 88 | 4.1011 | - | |
|
| 1.5517 | 90 | 4.0618 | 4.1283 | |
|
| 1.5862 | 92 | 4.0696 | - | |
|
| 1.6207 | 94 | 4.1508 | - | |
|
| 1.6552 | 96 | 4.0182 | - | |
|
| 1.6897 | 98 | 4.1442 | - | |
|
| 1.7241 | 100 | 4.2017 | - | |
|
| 1.7586 | 102 | 4.097 | - | |
|
| 1.7931 | 104 | 4.2886 | - | |
|
| 1.8103 | 105 | - | 4.1213 | |
|
| 1.8276 | 106 | 4.0573 | - | |
|
| 1.8621 | 108 | 4.1101 | - | |
|
| 1.8966 | 110 | 4.1942 | - | |
|
| 1.9310 | 112 | 4.122 | - | |
|
| 1.9655 | 114 | 4.1533 | - | |
|
| 2.0 | 116 | 4.0961 | - | |
|
|
|
|
|
### Framework Versions |
|
- Python: 3.10.12 |
|
- Sentence Transformers: 3.1.1 |
|
- Transformers: 4.45.2 |
|
- PyTorch: 2.5.1+cu121 |
|
- Accelerate: 1.1.1 |
|
- Datasets: 3.1.0 |
|
- Tokenizers: 0.20.3 |
|
|
|
## Citation |
|
|
|
### BibTeX |
|
|
|
#### Sentence Transformers |
|
```bibtex |
|
@inproceedings{reimers-2019-sentence-bert, |
|
title = "Sentence-BERT: Sentence Embeddings using Siamese BERT-Networks", |
|
author = "Reimers, Nils and Gurevych, Iryna", |
|
booktitle = "Proceedings of the 2019 Conference on Empirical Methods in Natural Language Processing", |
|
month = "11", |
|
year = "2019", |
|
publisher = "Association for Computational Linguistics", |
|
url = "https://arxiv.org/abs/1908.10084", |
|
} |
|
``` |
|
|
|
#### TripletLoss |
|
```bibtex |
|
@misc{hermans2017defense, |
|
title={In Defense of the Triplet Loss for Person Re-Identification}, |
|
author={Alexander Hermans and Lucas Beyer and Bastian Leibe}, |
|
year={2017}, |
|
eprint={1703.07737}, |
|
archivePrefix={arXiv}, |
|
primaryClass={cs.CV} |
|
} |
|
``` |
|
|
|
<!-- |
|
## Glossary |
|
|
|
*Clearly define terms in order to be accessible across audiences.* |
|
--> |
|
|
|
<!-- |
|
## Model Card Authors |
|
|
|
*Lists the people who create the model card, providing recognition and accountability for the detailed work that goes into its construction.* |
|
--> |
|
|
|
<!-- |
|
## Model Card Contact |
|
|
|
*Provides a way for people who have updates to the Model Card, suggestions, or questions, to contact the Model Card authors.* |
|
--> |